Contains information about a specific recurring subscription charge
Request
Property Name | Type | Required | Description |
---|---|---|---|
| decimal | Create Merchant-Managed Subscription: Required for ACH/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. |
| object | Create Merchant-Managed Subscription:
Optional; do not include if sending | Contains payerInfo properties. |
| object | Create Merchant-Managed Subscription:
Required for | Contains paymentSource 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 ACH/ECP and SEPA Direct Debit | Value must be true. Pass this parameter to indicate that you have obtained the shopper's permission to debit their account. |
| object | Create Merchant-Managed Subscription: Optional | Contains transactionFraudInfo properties. |
| object | Create Merchant-Managed Subscription Create Merchant-Managed Subscription Charge: Optional | Contains transactionMetaData properties. |
| object | Create Merchant-Managed Subscription Charge: Optional | Contains chargeInfo properties. |
| object | Optional | Contains level3Data properties. |
| object | Create Merchant-Managed Subscription: Optional | Contains threeDSecure 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 | Required |
---|---|---|
| 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. |
| integer | 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. |
| object | See paymentSource. |
| object | See chargeInfo. |
| object | See processingInfo. |
| object | See fraudResultInfo. |
| object | See transactionMetaData. |
| object | See refunds. |
| object | See level3Data. |
| object | See threeDSecure. |
| string | Merchant-specific transaction information. |