v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Partner Billing

Create a partner subscription token

Creates a partner subscription token (called by partner using retailer's access token)

🔒 Requires: billing:partner_subscription:write scope

post/partner/billing/token

Request body

coupon_codestring

CouponCode is the coupon code to be attached to the activation

price_handlestring required

ProductPricePointHandle is the product price point handle

product_handlestring required

ProductHandle is the product handle

return_urlstring required

ReturnURL is the URL to which the user is redirected to after giving his/her consent

Example request

{
  "components": [
    {
      "component_handle": "additional_registers",
      "component_price_handle": "lite",
      "quantity": 1
    }
  ],
  "coupon_code": "TEST10POFFFORLIFE",
  "price_handle": "small-v1",
  "product_handle": "small-v1",
  "return_url": "https://www.example.com/return"
}

Response

Example response

{
  "data": {
    "expires_at": "2020-10-06T05:07:26Z",
    "expires_in": "86400",
    "token": "0a7e36eb05a94bf1a4d3daeff0f561f9"
  }
}