subscription

Request

Property NameTypeRequiredDescription
statusstringOptionalStatus of the subscription:
A = Active
C = Cancelled
* D = Declined
cancellation-reasonstringOptionalReason for the subscription's cancellation. 50-character limit.
underlying-sku-idlongOptional
(required with quantity)
ID of the SKU (contract) that the subscription is attributed to.
underlying-sku-namestringOptionalName of the SKU (contract) that the subscription is attributed to.
shopper-idlongOptionalBlueSnap's global ID for the shopper who purchased the subscription.
credit-cardcontainerOptionalContainer of credit-card properties.
paypalstringOptionalEmpty field to indicate a PayPal charge, consists only of the tag.
paypal-subscriptioncontainerOptionalContainer of paypal-subscription properties.
override-recurring-chargecontainerOptionalContainer of override-recurring-charge properties.
couponstringOptionalCoupon code.
next-charge-datedateOptionalNext charge date of the subscription.
Format: DD-MMM-YY
auto-renewbooleanOptionalDetermines whether the subscription will be automatically renewed.
quantityintegerOptionalDetermines the quantity of the subscription to which the shopper is subscribed.

Value must be greater than zero.

Response

Property NameTypeDescription
subscription-idstringSubscription ID.
statusstringStatus of the subscription:
A = Active
C = Cancelled
* D = Declined
cancellation-reasonstringProduct name.
underlying-sku-idlongID of the SKU (contract) that the subscription is attributed to.
underlying-sku-namestringName of the SKU (contract) that the subscription is attributed to.
shopper-idlongBlueSnap's global ID for the shopper who purchased the subscription.
credit-cardcontainerContainer of credit-card properties.
paypalstringEmpty field to indicate the a PayPal charge, consists only of the tag.
paypal-subscriptioncontainerContainer of paypal-subscription properties.
catalog-recurring-chargecontainerContainer of catalog-recurring-charge properties.
override-recurring-chargecontainerContainer of override-recurring-charge properties.
couponstringCoupon code.
charge-frequencystringPayment frequency:
none
once
ondemand
daily
weekly
biweekly
monthly
bimonthly
quarterly
semiannually
annually
biannually
triannually
upon_demand
next-charge-datedateNext charge date of the subscription.
Format: DD-MMM-YY
manual-recurring-infocontainerContainer of manual-recurring-info properties.
auto-renewbooleanDetermines whether the subscription will be automatically renewed.
last-charge-resultcontainerContainer of last-charge-result properties.
subscription-chargescontainerContainer of subscription-charges properties.