Skip to content
EntitlerDocs

POST/v1/customers/{external_id}/billing:sync

Follow a customer's Stripe billing

Reads the customer's Stripe subscriptions on every linked Stripe connection again and updates what they hold to match; changed says whether anything changed. Needs customers:write or billing:self; a customer token or identity caller also needs the team plan's customer portal and is limited to one call every 10 seconds per customer.

curl -X POST 'https://api.entitler.co/v1/customers/ada/billing:sync' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
external_idrequiredstringThe customer's external ID, or me for the customer a customer token or identity token names.

Request body

object

  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring

Responses

200The SyncBillingResponse message.

SyncBillingResponse

  • changedbooleanrequired

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired