Contains information about a specific subscription
Request
Property Name | Type | Required | Description |
---|---|---|---|
| integer | Required for Create Subscription | ID of the billing plan associated with this subscription. |
| integer | Optional
Do not include if sending | ID of an existing vaulted shopper. |
| container | Optional
Do not include if sending | Container of payer-info properties. |
| container | Required for Create Subscription if sending Optional if sending | Container of payment-source properties. |
| integer | Optional Create Subscription requests only | Quantity to apply to the subscription.
Default is |
| string | Optional | Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters. |
| string | Optional | Merchant's support phone number that appears on the shopper's bank statement. Maximum 20 characters. |
| integer | Optional | Number of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription. Note: This value must be greater than |
| decimal | Optional | Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription. |
| decimal | Optional | Initial amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription. If you override the price, any later changes to the plan's price are not applied to this subscription. |
| container | Required for Create Subscription | Container of transaction-fraud-info properties. |
| boolean | Optional Optional Update Subscription requests only | Determines whether the subscription automatically continues, or expires at the end of the current period. |
| boolean | Required for SEPA Direct Debit Create Subscription requests only | Value must be Pass this parameter to indicate that you have obtained the shopper's authorization of the SEPA Direct Debit mandate. |
| string | Optional Create/Update Subscription requests only | Next charge date. If you change this, the date of future recurring charges is adjusted accordingly. Format: yyyy-mm-dd |
| string | Optional Create/Update Subscription requests only | Permitted values:
|
| container | Optional | Container of level-3-data properties. |
| container | Optional | Container of three-d-secure properties. |
| string | Optional | Identifies the order type. |
| string | Optional | ID of the tax quote for the initial subscription charge. For details, see Taxes guide. |
| string | Optional | ID of the tax quote for recurring subscription charges. For details, see Taxes guide. |
Response
Property Name | Type | Required |
---|---|---|
| integer | BlueSnap identifier for the subscription. |
| integer | ID of the billing plan associated with this subscription. |
| integer | ID of an existing vaulted shopper. |
| string | Possible values:
|
| integer | Quantity to apply to the subscription.
Default is |
| string | Description of the transaction, which appears on the shopper's credit card statement. |
| string | Description of the transaction, which appears on the shopper's credit card statement. |
| string | Possible values:
|
| integer | Number of days in the trial period.
For example: |
| integer | Number of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription. |
| decimal | Recurring amount to be charged.
For example: |
| decimal | Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription. |
| string | Currency code (ISO 4217) of the amount to be charged. Refer to Currency codes. |
| decimal | Amount of the initial charge.
For example: |
| decimal | Initial amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription. If you override the price, any later changes to the plan's price are not applied to this subscription. |
| boolean | Determines whether the subscription automatically continues, or expires at the end of the current period. |
| string | Appears only if subscription is ACTIVE Next charge date. Format: yyyy-mm-dd |
| container | Container of payer-info properties. |
| container | Container of payment-source properties. |
| container | Create Subscription response only Container of charge properties. |
| container | Create Subscription response only Container of fraud-result-info properties. |
| container | Container of level-3-data properties. |
| container | Container of three-d-secure properties. |
| boolean | Identifies if the transaction is a regularly scheduled event. Possible values:
Refer to Card on File Guide. |
| string | ID of the tax quote for recurring subscription charges. For details, see Taxes guide. |