Start saving a card

POST

https://billing.ezghcloud.com/v1/organizations/{orgId}/checkout-sessions

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid

Returns

201

Created

JSON

idstringrequired
statusopenorcompleteorexpiredrequired
clientSecretstringrequired
For Stripe's Checkout Elements SDK in the browser. Shown only here.
publishableKeystringrequired
Stripe's publishable key, for the same SDK.

401

unauthenticated: no valid credential.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

403

access_denied: the caller isn't allowed to (the message names the action); forbidden_origin: a cookie-authenticated write from another site.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

404

not_found: the organization (or one the caller doesn't belong to), or the resource, doesn't exist.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

429

too_many_requests: slow down.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

502

payment_provider_error: the payment provider request failed.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

503

unavailable, ledger_unavailable or payments_unavailable: retry later.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

Start saving a card

curl --request POST \
  --url https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkout-sessions \
  --header 'Authorization: Bearer <token>'

const url = 'https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkout-sessions';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

import requests

url = "https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkout-sessions"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

Response example

{
  "id": "string",
  "status": "open",
  "clientSecret": "string",
  "publishableKey": "string"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}