Request
| Property Name | Type | Required | Description |
|---|---|---|---|
status | string | Optional | Status of the subscription: A = Active C = Cancelled * D = Declined |
cancellation-reason | string | Optional | Reason for the subscription's cancellation. 50-character limit. |
underlying-sku-id | long | Optional (required with quantity) | ID of the SKU (contract) that the subscription is attributed to. |
underlying-sku-name | string | Optional | Name of the SKU (contract) that the subscription is attributed to. |
shopper-id | long | Optional | BlueSnap's global ID for the shopper who purchased the subscription. |
credit-card | container | Optional | Container of credit-card properties. |
paypal | string | Optional | Empty field to indicate a PayPal charge, consists only of the tag. |
paypal-subscription | container | Optional | Container of paypal-subscription properties. |
override-recurring-charge | container | Optional | Container of override-recurring-charge properties. |
coupon | string | Optional | Coupon code. |
next-charge-date | date | Optional | Next charge date of the subscription. Format: DD-MMM-YY |
auto-renew | boolean | Optional | Determines whether the subscription will be automatically renewed. |
quantity | 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 |
|---|---|---|
subscription-id | string | Subscription ID. |
status | string | Status of the subscription: A = Active C = Cancelled * D = Declined |
cancellation-reason | string | Product name. |
underlying-sku-id | long | ID of the SKU (contract) that the subscription is attributed to. |
underlying-sku-name | string | Name of the SKU (contract) that the subscription is attributed to. |
shopper-id | long | BlueSnap's global ID for the shopper who purchased the subscription. |
credit-card | container | Container of credit-card properties. |
paypal | string | Empty field to indicate the a PayPal charge, consists only of the tag. |
paypal-subscription | container | Container of paypal-subscription properties. |
catalog-recurring-charge | container | Container of catalog-recurring-charge properties. |
override-recurring-charge | container | Container of override-recurring-charge properties. |
coupon | string | Coupon code. |
charge-frequency | string | Payment frequency: none once ondemand daily weekly biweekly monthly bimonthly quarterly semiannually annually biannually triannually upon_demand |
next-charge-date | date | Next charge date of the subscription. Format: DD-MMM-YY |
manual-recurring-info | container | Container of manual-recurring-info properties. |
auto-renew | boolean | Determines whether the subscription will be automatically renewed. |
last-charge-result | container | Container of last-charge-result properties. |
subscription-charges | container | Container of subscription-charges properties. |