API Reference

Create a partner subscription token

post
https://{domain_prefix}.retail.lightspeed.app/api/2026-04/partner/billing/token

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

šŸ”’ Requires: billing:partner_subscription:write scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Body Params
components
array of objects

Components is a list of components to add on to the plan

components
string

CouponCode is the coupon code to be attached to the activation

string
required

ProductPricePointHandle is the product price point handle

string
required

ProductHandle is the product handle

string
required

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

Response

Updated 8 days ago

Language
Credentials
Bearer
URL
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago