Create checkout session

POST

https://api.sureshake.com/v2/billing/checkout

Request body JSON required

planId
individual_starter
or
individual_professional
or
individual_enterprise
or
business_startup
or
business_growth
or
business_enterprise
+1 more
required

billingCycle
monthly
or
quarterly
or
annual
required
entityId
optional
string
format: uuid
successUrl
optional
string
format: uri
cancelUrl
optional
string
format: uri

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
- url
  string
  required
  format: uri
- expiresAt
  number
  or null
  required
- planId
  individual_starter
  or
  individual_professional
  or
  individual_enterprise
  or
  business_startup
  or
  business_growth
  or
  business_enterprise
  +1 more
  required
- billingCycle
  monthly
  or
  quarterly
  or
  annual
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

502

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create checkout session

curl --request POST \
  --url https://api.sureshake.com/v2/billing/checkout \
  --header 'Content-Type: application/json' \
  --data '
{
  "planId": "individual_starter",
  "billingCycle": "monthly",
  "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  "successUrl": "http://example.com",
  "cancelUrl": "http://example.com"
}
'

const url = 'https://api.sureshake.com/v2/billing/checkout';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    planId: 'individual_starter',
    billingCycle: 'monthly',
    entityId: '156e622c-6cdf-4c27-9bc9-2f2db69919f5',
    successUrl: 'http://example.com',
    cancelUrl: 'http://example.com'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/billing/checkout"

payload = {
    "planId": "individual_starter",
    "billingCycle": "monthly",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "successUrl": "http://example.com",
    "cancelUrl": "http://example.com"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "string",
    "url": "http://example.com",
    "expiresAt": 0,
    "planId": "individual_starter",
    "billingCycle": "monthly"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}