{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"subscription","type":"basic","slug":"subscription","excerpt":"","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`status`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Status of the subscription:\\n * **A** = Active\\n * **C** = Cancelled\\n * **D** = Declined\",\n \"0-2\": \"Optional\",\n \"1-0\": \"`cancellation-reason`\",\n \"1-3\": \"Reason for the subscription's cancellation.\",\n \"1-2\": \"Optional\",\n \"1-1\": \"*string*\",\n \"2-0\": \"`underlying-sku-id`\",\n \"4-0\": \"`shopper-id`\",\n \"5-0\": \"`credit-card`\",\n \"6-0\": \"`paypal`\",\n \"7-0\": \"`paypal-subscription`\",\n \"2-1\": \"*long*\",\n \"4-1\": \"*long*\",\n \"5-1\": \"container\",\n \"6-1\": \"*string*\",\n \"7-1\": \"container\",\n \"7-2\": \"Optional\",\n \"6-2\": \"Optional\",\n \"5-2\": \"Optional\",\n \"4-2\": \"Optional\",\n \"2-2\": \"Optional\\n(required with `quantity`)\",\n \"2-3\": \"ID of the SKU (contract) that the subscription is attributed to.\",\n \"4-3\": \"BlueSnap's global ID for the shopper who purchased the subscription.\",\n \"5-3\": \"Container of [credit-card](doc:credit-card) properties.\",\n \"6-3\": \"Empty field to indicate a PayPal charge, consists only of the tag.\",\n \"7-3\": \"Container of [paypal-subscription](doc:paypal-subscription) properties.\",\n \"8-0\": \"`override-recurring-charge`\",\n \"8-1\": \"container\",\n \"8-2\": \"Optional\",\n \"8-3\": \"Container of [override-recurring-charge](doc:override-recurring-charge) properties.\",\n \"9-0\": \"`coupon`\",\n \"9-1\": \"*string*\",\n \"9-2\": \"Optional\",\n \"9-3\": \"Coupon code.\",\n \"10-0\": \"`next-charge-date`\",\n \"10-1\": \"*date*\",\n \"10-3\": \"Next charge date of the subscription.\\nFormat: DD-MMM-YY\",\n \"10-2\": \"Optional\",\n \"11-0\": \"`auto-renew`\",\n \"11-1\": \"*boolean*\",\n \"11-2\": \"Optional\",\n \"11-3\": \"Determines whether the subscription will be automatically renewed.\",\n \"3-0\": \"`underlying-sku-name`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Name of the SKU (contract) that the subscription is attributed to.\"\n },\n \"cols\": 4,\n \"rows\": 12\n}\n[/block]\n\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"1-0\": \"`status`\",\n \"2-0\": \"`cancellation-reason`\",\n \"1-1\": \"*string*\",\n \"2-1\": \"*string*\",\n \"1-2\": \"Status of the subscription:\\n * **A** = Active\\n * **C** = Cancelled\\n * **D** = Declined\",\n \"2-2\": \"Product name.\",\n \"3-0\": \"`underlying-sku-id`\",\n \"5-0\": \"`shopper-id`\",\n \"6-0\": \"`credit-card`\",\n \"7-0\": \"`paypal`\",\n \"8-0\": \"`paypal-subscription`\",\n \"10-0\": \"`override-recurring-charge`\",\n \"3-1\": \"*long*\",\n \"5-1\": \"*long*\",\n \"6-1\": \"container\",\n \"7-1\": \"*string*\",\n \"8-1\": \"container\",\n \"10-1\": \"container\",\n \"3-2\": \"ID of the SKU (contract) that the subscription is attributed to.\",\n \"5-2\": \"BlueSnap's global ID for the shopper who purchased the subscription.\",\n \"6-2\": \"Container of [credit-card](doc:credit-card) properties.\",\n \"7-2\": \"Empty field to indicate the a PayPal charge, consists only of the tag.\",\n \"8-2\": \"Container of [paypal-subscription](doc:paypal-subscription) properties.\",\n \"10-2\": \"Container of [override-recurring-charge](doc:override-recurring-charge) properties.\",\n \"11-2\": \"Coupon code.\",\n \"11-0\": \"`coupon`\",\n \"11-1\": \"*string*\",\n \"13-0\": \"`next-charge-date`\",\n \"13-1\": \"*date*\",\n \"13-2\": \"Next charge date of the subscription.\\nFormat: DD-MMM-YY\",\n \"15-0\": \"`auto-renew`\",\n \"15-1\": \"*boolean*\",\n \"15-2\": \"Determines whether the subscription will be automatically renewed.\",\n \"0-0\": \"`subscription-id`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"Subscription ID.\",\n \"9-0\": \"`catalog-recurring-charge`\",\n \"9-1\": \"container\",\n \"9-2\": \"Container of [catalog-recurring-charge](doc:catalog-recurring-charge) properties.\",\n \"12-0\": \"`charge-frequency`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"Payment frequency:\\n * **none**\\n * **once**\\n * **ondemand**\\n * **daily**\\n * **weekly**\\n * **biweekly**\\n * **monthly**\\n * **bimonthly**\\n * **quarterly**\\n * **semiannually**\\n * **annually**\\n * **biannually**\\n * **triannually**\\n * **upon_demand**\",\n \"14-0\": \"`manual-recurring-info`\",\n \"14-1\": \"container\",\n \"14-2\": \"Container of [manual-recurring-info](doc:manual-recurring-info) properties.\",\n \"16-0\": \"`last-charge-result`\",\n \"17-0\": \"`subscription-charges`\",\n \"16-1\": \"container\",\n \"16-2\": \"Container of [last-charge-result](doc:last-charge-result) properties.\",\n \"17-2\": \"Container of [subscription-charges](doc:subscription-charges) properties.\",\n \"17-1\": \"container\",\n \"4-0\": \"`underlying-sku-name`\",\n \"4-1\": \"*string*\",\n \"4-2\": \"Name of the SKU (contract) that the subscription is attributed to.\"\n },\n \"cols\": 3,\n \"rows\": 18\n}\n[/block]","updates":[],"order":108,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c742637ad58c70033b9c744","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"5c742637ad58c70033b9c6a1","version":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"Main","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c742637ad58c70033b9c699","5c742637ad58c70033b9c69a","5c742637ad58c70033b9c69b","5c742637ad58c70033b9c69c","5c742637ad58c70033b9c69d","5c742637ad58c70033b9c69e","5c742637ad58c70033b9c69f","5c742637ad58c70033b9c6a0","5c742637ad58c70033b9c6a1","5c742637ad58c70033b9c6a2","5c742637ad58c70033b9c6a3"],"_id":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedbcf19b49e8004462d199","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-28T14:26:30.590Z","githubsync":"","__v":0}subscription
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.
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.
paypal
string
Optional
Empty field to indicate a PayPal charge, consists only of the tag.
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.
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.
paypal
string
Empty field to indicate the a PayPal charge, consists only of the tag.
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
auto-renew
boolean
Determines whether the subscription will be automatically renewed.
