Reference / Billing

Subscribe the current customer's org to a plan; returns the Payment Element client secret.

POST /v1/billing/subscribe

Secret API key operationId: subscribe

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Request body · required

organization_id string<uuid> required uuid
plan_id string<uuid> required uuid

Responses

200 Subscription created

{
  "data": {
    "client_secret": "string",
    "connected_account_id": "string",
    "plan_key": "string",
    "publishable_key": "string",
    "status": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

Request

curl -X POST "https://api.identrahq.com/v1/billing/subscribe" \
  -H "Content-Type: application/json" \
  -d '{
  "organization_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
  "plan_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f"
}'

Try it

live request

POST https://api.identrahq.com/v1/billing/subscribe

Request body

application/json