Request
Property Name | Type | Required | Description |
---|---|---|---|
| string | Optional | Status of the subscription:
|
| string | Optional | Reason for the subscription's cancellation. |
| long | Optional
(required with | ID of the SKU (contract) that the subscription is attributed to. |
| string | Optional | Name of the SKU (contract) that the subscription is attributed to. |
| long | Optional | BlueSnap's global ID for the shopper who purchased the subscription. |
| container | Optional | Container of credit-card properties. |
| string | Optional | Empty field to indicate a PayPal charge, consists only of the tag. |
| container | Optional | Container of paypal-subscription properties. |
| container | Optional | Container of override-recurring-charge properties. |
| string | Optional | Coupon code. |
| date | Optional | Next charge date of the subscription. Format: DD-MMM-YY |
| boolean | Optional | Determines whether the subscription will be automatically renewed. |
| integer | Optional | Determines the quantity of the subscription to which the shopper is subscribed. Value must be greater than zero. |
Response
Property Name | Type | Description |
---|---|---|
| string | Subscription ID. |
| string | Status of the subscription:
|
| string | Product name. |
| long | ID of the SKU (contract) that the subscription is attributed to. |
| string | Name of the SKU (contract) that the subscription is attributed to. |
| long | BlueSnap's global ID for the shopper who purchased the subscription. |
| container | Container of credit-card properties. |
| string | Empty field to indicate the a PayPal charge, consists only of the tag. |
| container | Container of paypal-subscription properties. |
| container | Container of catalog-recurring-charge properties. |
| container | Container of override-recurring-charge properties. |
| string | Coupon code. |
| string | Payment frequency:
|
| date | Next charge date of the subscription. Format: DD-MMM-YY |
| container | Container of manual-recurring-info properties. |
| boolean | Determines whether the subscription will be automatically renewed. |
| container | Container of last-charge-result properties. |
| container | Container of subscription-charges properties. |