Contains information about a specific recurring subscription charge
Request
Property Name | Type | Required | Description |
---|---|---|---|
| decimal | Create Merchant-Managed Subscription: Required for ACHP/ECP and SEPA Direct Debit; optional otherwise Create Merchant-Managed Subscription Charge: Required | Charge amount. |
| string | Required | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
| integer | Create Merchant-Managed Subscription:
Optional; do not include if sending | ID of an existing vaulted shopper. |
| container | Create Merchant-Managed Subscription:
Optional; do not include if sending | Container of payer-info properties. |
| container | Create Merchant-Managed Subscription:
Required for | Container of payment-source properties. |
| string | Create Merchant-Managed Subscription: Optional | Description of the transaction, which appears on the shopper's bank statement. Maximum 20 characters. |
| string | Create Merchant-Managed Subscription: Optional | Merchant's support phone number that will appear on the shopper's bank statement. Maximum 20 characters. |
| boolean | Create Merchant-Managed Subscription: Required for SEPA Direct Debit | Value must be true. Pass this parameter to indicate that you have obtained the shopper's permission to debit their account. |
| container | Create Merchant-Managed Subscription: Optional | Container of three-d-secure properties. |
| container | Create Merchant-Managed Subscription: Optional | Container of transaction-fraud-info properties. |
| container | Create Merchant-Managed Subscription Create Merchant-Managed Subscription Charge: Optional | Container of transaction-meta-data properties. |
| container | Create Merchant-Managed Subscription Charge: Optional | Container of charge-info properties. |
| container | Optional | Container of level-3-data properties. |
| boolean | Create Merchant-Managed Subscription Charge: Optional | Value can be true or false. Pass this parameter to identify that the transaction is a regularly scheduled event. |
| string | Optional | Provides merchant-specific transaction information. 1–50 characters. Special characters are not recommended. |
| string | Optional | Identifies the order type. |
Response
Property Name | Type | Description |
---|---|---|
| integer | BlueSnap identifier for the charge. |
| integer | BlueSnap identifier for the subscription. |
| integer | BlueSnap identifier for the billing plan. |
| integer | ID of the vaulted shopper. |
| string | BlueSnap identifier for the transaction. |
| string | Date (yyyy-mm-dd) of the transaction. For example: |
| decimal | Charge amount. |
| string | Currency code (ISO 4217) of the charge. See Currency codes. |
| string | Description of the transaction, which appears on the shopper's credit card statement. |
| container | Container of payment-source properties. |
| container | Container of charge-info properties. |
| container | Container of processing-info properties. |
| container | Container of fraud-result-info properties. |
| container | Container of transaction-meta-data properties. |
| container | Container of refunds properties. |
| container | Container of three-d-secure properties. |
| container | Container of level-3-data properties. |
| string | Merchant-specific transaction information. |