01.software Docs

membershipRecoveryIntent

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

All HTTP operations
POST
/api/memberships/recovery/intent

Requires an sk01_ key with membership read scope and no Origin header. Reads only existing same-tenant recovery evidence; never prepares a charge or writes custody. DTOs exclude payment-method references, custody and stored PSP values. A discovered console_managed generation returns 409 conflict without recovery evidence.

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.

Request Body

application/json
  1. body
customerId*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
subscribeIntentKey*string
Length1 <= length <= 512
customerRef*string
Length1 <= length <= 512

Response Body

Successful operation

application/json
  1. response
snapshots*array<>
Itemsitems <= 2

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/recovery/intent' \  -H 'Content-Type: application/json' \  -d '{  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",  "subscribeIntentKey": "string",  "customerRef": "string"}'
Example Response
{  "snapshots": [    {      "id": "string",      "customer": "string",      "plan": "string",      "price": "string",      "subscribeIntentKey": "string",      "customerRefMatches": true,      "status": "incomplete",      "amount": 0,      "currency": "string",      "subscribePeriodStart": "string",      "subscribePeriodEnd": "string",      "currentPeriodEnd": "string",      "billingInterval": "month",      "intervalCount": 1,      "updatedAt": "string",      "prepared": {        "membershipId": "string",        "status": "trialing"      }    }  ]}