Subscriptions

Mark subscription invoice as paid

Changed on

Marks the latest invoice of a subscription as paid in the billing provider. The invoice must exist and have an OPEN status.

post/api/v1/subscriptions/{id}/invoice/paid

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/subscriptions/{id}/invoice/paid
  • Auth
    API key in header X-API-KEY

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

Confirmation that the invoice was marked as paid.

Changes

    • warning

      added the new ContractNotFound enum value to the response property for the response status

    • warning

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

    • warning

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

    • warning

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

    • warning

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

    • warning

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status