Customers

Get subscriptions for customer by external ID

Changed on

Returns all subscriptions for a customer looked up by external_id, with line-item meters and entitlements attached (no pagination).

get/customers/external/{external_id}/subscriptions

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/customers/external/{external_id}/subscriptions
  • Auth
    API key in header x-api-key

Path parameters

external_idstring required

Customer External ID

Query parameters

expandstring

Comma-separated fields to expand: subscription_line_items, subscription_line_items.meters, entitlements, plan, customer

Response

OK

Changes

  • 3798546cc4a3Revision changes
    • warning

      added the new END_OF_MONTH enum value to the // response property for the response status

    • warning

      added the new END_OF_NEXT_MONTH enum value to the // response property for the response status

  • 80eb0267435cRevision changes
    • info

      added the optional property /// to the response with the status