01.software Docs

membershipBillingCustody

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/memberships/billing-custody

Requires an sk01_ write key, no Origin header, the active delegated billing connection, and HMAC proof over billing-custody.v1:{rawBody} with timestamp/delivery identity. Ciphertext is opaque and grants no charge-result authority.

Authorization

serverSecretKey
headerAuthorizationBearer <token>

Public integration credential: opaque sk01_ secret API key only; PAT and Customer JWT are not supported by this scheme. Requires tenant binding and the read or write scope named by the operation.

Header Parameters

x-membership-signature*string
Length1 <= length
x-membership-timestamp*string
Length1 <= length
x-membership-delivery-id*string
Length1 <= length

Request Body

application/json
  1. body
kind*"billing-custody.v1"
Value in"billing-custody.v1"
membershipId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
generation*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
action*"read"
Value in"read"

Response Body

Successful operation

application/json
  1. response
action*"read"
Value in"read"
version*integer
Range0 < value <= 9007199254740991
ciphertext*string
Length1 <= length <= 16384

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/memberships/billing-custody' \  -H 'x-membership-signature: string' \  -H 'x-membership-timestamp: string' \  -H 'x-membership-delivery-id: string' \  -H 'Content-Type: application/json' \  -d '{  "kind": "billing-custody.v1",  "membershipId": "8072cc74-4782-4f2c-827c-699c48ce2092",  "generation": "9f472193-7598-4291-926c-6d116edc9e9b",  "action": "read"}'
Example Response
{  "action": "read",  "version": 1,  "ciphertext": "string"}