Customers

​

The companies you bill. Each customer has a Spondo Billing ID (cus_…) and usually your own ID for it (externalId); every route under /customers/{id} also works as /customers/external/{externalId}. Aliases keep other IDs resolving to the customer, customer API keys let a customer send its own usage, funding instructions and portal sessions connect it to Stripe, and the state endpoint sums up what it has right now.

Customers Operations
  • post/customers
  • get/customers
  • get/customers/{id}
  • put/customers/{id}
  • delete/customers/{id}
  • get/customers/external/{externalId}
  • put/customers/external/{externalId}
  • delete/customers/external/{externalId}
  • put/customers/{customerExternalId}/users/{userExternalId}
  • post/customers/{id}/aliases
  • get/customers/{id}/aliases
  • post/customers/external/{externalId}/aliases
  • get/customers/external/{externalId}/aliases
  • delete/customers/{id}/aliases/{alias}
  • delete/customers/external/{externalId}/aliases/{alias}
  • post/customers/{id}/api-keys
  • get/customers/{id}/api-keys
  • post/customers/external/{externalId}/api-keys
  • get/customers/external/{externalId}/api-keys
  • delete/customers/{id}/api-keys/{apiKeyId}
  • delete/customers/external/{externalId}/api-keys/{apiKeyId}
  • post/customers/{id}/funding-instructions
  • get/customers/{id}/funding-instructions
  • post/customers/external/{externalId}/funding-instructions
  • get/customers/external/{externalId}/funding-instructions
  • get/customers/{id}/state
  • get/customers/external/{externalId}/state
  • post/customer-portals
Previous
Introduction
Next
Create a customer
  • Start
  • Measure usage and cost
  • Price and bill
  • Prove value
  • API
  • SDK
Powered by Scalar
logologo
Spondo BillingSpondo Billing
Get an API keyGet an API key
GuidesGuidesAPI referenceAPI referenceSDKSDK