Skip to main content
GET
/
v2
/
partner
/
billing-settings
Get Billing Settings
curl --request GET \
  --url https://api.trykintsugi.com/v2/partner/billing-settings \
  --header 'X-API-KEY: <api-key>'
{
  "defaultPendingRequest": {
    "id": "<string>",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "requestedBillingMode": "<string>"
  },
  "defaultScheduledChange": {
    "billingMode": "<string>",
    "effectiveFrom": "2023-12-25"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-partner-id
string | null

Target partner. Required for referral partner API keys (selects the owned sub-partner; omitting it returns 400 PARTNER_ID_REQUIRED). For multi-partner bearer users, selects the active partner.

Maximum string length: 100

Response

Successful Response

Partner-level billing default summary.

Per-org overrides are paginated on a separate endpoint (GET /partner/billing-settings/overrides) to avoid unbounded response sizes when a partner has many client organizations.

​
defaultMode
enum<string>
required
Available options:
PARTNER_MANAGED,
CLIENT_MANAGED
​
defaultPendingRequest
PendingChangeRequest · object

Lightweight pending request info embedded in billing settings responses.

​
defaultScheduledChange
ScheduledBillingChange · object

Future-dated billing interval surfaced on the current response.