Customers

Get a single customer by ID

Retrieves a customer by their unique identifier, including billing information and subscription status.

get/api/v1/customers/{id}

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

The customer object with full details.

Changes

Changed in 10 of the 115 revisions of this API.142

    • added the new ContractNotFound enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new STRIPE_INVOICING enum value to the data/integrations/items/vendorIdentifier response property for the response status 200

      response-property-enum-value-added

    • added the new GovernanceNotEnabled enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new AIRWALLEX enum value to the data/integrations/items/vendorIdentifier response property for the response status 200

      response-property-enum-value-added

    • added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

    • added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new PREQUEL enum value to the data/integrations/items/vendorIdentifier response property for the response status 200

      response-property-enum-value-added

    • added the new DataExportIntegrationError enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new RECEIVED enum value to the data/integrations/items/vendorIdentifier response property for the response status 200

      response-property-enum-value-added