{"_id":"5b19742cb3baf90003cab596","category":{"_id":"5b19742cb3baf90003cab4f0","version":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5adf4e59ac13b80003d23152","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b19742cb3baf90003cab4e8","5b19742cb3baf90003cab4e9","5b19742cb3baf90003cab4ea","5b19742cb3baf90003cab4eb","5b19742cb3baf90003cab4ec","5b19742cb3baf90003cab4ed","5b19742cb3baf90003cab4ee","5b19742cb3baf90003cab4ef","5b19742cb3baf90003cab4f0","5b19742cb3baf90003cab4f1","5b19742cb3baf90003cab4f2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-28T14:26:30.590Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":107,"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    \"3-0\": \"`shopper-id`\",\n    \"4-0\": \"`credit-card`\",\n    \"5-0\": \"`paypal`\",\n    \"6-0\": \"`paypal-subscription`\",\n    \"2-1\": \"*long*\",\n    \"3-1\": \"*long*\",\n    \"4-1\": \"container\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"container\",\n    \"6-2\": \"Optional\",\n    \"5-2\": \"Optional\",\n    \"4-2\": \"Optional\",\n    \"3-2\": \"Optional\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"ID of the SKU that the subscription is attributed to.\",\n    \"3-3\": \"BlueSnap's global ID for the shopper who purchased the subscription.\",\n    \"4-3\": \"Container of [credit-card](doc:credit-card) properties.\",\n    \"5-3\": \"Empty field to indicate a PayPal charge, consists only of the tag.\",\n    \"6-3\": \"Container of [paypal-subscription](doc:paypal-subscription) properties.\",\n    \"7-0\": \"`override-recurring-charge`\",\n    \"7-1\": \"container\",\n    \"7-2\": \"Optional\",\n    \"7-3\": \"Container of [override-recurring-charge](doc:override-recurring-charge) properties.\",\n    \"8-0\": \"`coupon`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Optional\",\n    \"8-3\": \"Coupon code.\",\n    \"9-0\": \"`next-charge-date`\",\n    \"9-1\": \"*date*\",\n    \"9-3\": \"Next charge date of the subscription.\\nFormat: DD-MMM-YY\",\n    \"9-2\": \"Optional\",\n    \"10-0\": \"`auto-renew`\",\n    \"10-1\": \"*boolean*\",\n    \"10-2\": \"Optional\",\n    \"10-3\": \"Determines whether the subscription will be automatically renewed.\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\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    \"4-0\": \"`shopper-id`\",\n    \"5-0\": \"`credit-card`\",\n    \"6-0\": \"`paypal`\",\n    \"7-0\": \"`paypal-subscription`\",\n    \"9-0\": \"`override-recurring-charge`\",\n    \"3-1\": \"*long*\",\n    \"4-1\": \"*long*\",\n    \"5-1\": \"container\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"container\",\n    \"9-1\": \"container\",\n    \"3-2\": \"ID of the SKU that the subscription is attributed to.\",\n    \"4-2\": \"BlueSnap's global ID for the shopper who purchased the subscription.\",\n    \"5-2\": \"Container of [credit-card](doc:credit-card) properties.\",\n    \"6-2\": \"Empty field to indicate the a PayPal charge, consists only of the tag.\",\n    \"7-2\": \"Container of [paypal-subscription](doc:paypal-subscription) properties.\",\n    \"9-2\": \"Container of [override-recurring-charge](doc:override-recurring-charge) properties.\",\n    \"10-2\": \"Coupon code.\",\n    \"10-0\": \"`coupon`\",\n    \"10-1\": \"*string*\",\n    \"12-0\": \"`next-charge-date`\",\n    \"12-1\": \"*date*\",\n    \"12-2\": \"Next charge date of the subscription.\\nFormat: DD-MMM-YY\",\n    \"14-0\": \"`auto-renew`\",\n    \"14-1\": \"*boolean*\",\n    \"14-2\": \"Determines whether the subscription will be automatically renewed.\",\n    \"0-0\": \"`subscription-id`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Subscription ID.\",\n    \"8-0\": \"`catalog-recurring-charge`\",\n    \"8-1\": \"container\",\n    \"8-2\": \"Container of [catalog-recurring-charge](doc:catalog-recurring-charge) properties.\",\n    \"11-0\": \"`charge-frequency`\",\n    \"11-1\": \"*string*\",\n    \"11-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    \"13-0\": \"`manual-recurring-info`\",\n    \"13-1\": \"container\",\n    \"13-2\": \"Container of [manual-recurring-info](doc:manual-recurring-info) properties.\",\n    \"15-0\": \"`last-charge-result`\",\n    \"16-0\": \"`subscription-charges`\",\n    \"15-1\": \"container\",\n    \"15-2\": \"Container of [last-charge-result](doc:last-charge-result) properties.\",\n    \"16-2\": \"Container of [subscription-charges](doc:subscription-charges) properties.\",\n    \"16-1\": \"container\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]","excerpt":"","slug":"subscription","type":"basic","title":"subscription"}

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.

underlying-sku-id

long

Optional

ID of the SKU 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.

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 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.