Mark subscription invoice as paid

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

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.subscriptions.invoice.markAsPaid('x');

console.log(response.data);

200

{
  "data": {
    "id": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

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-ID · string

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).

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Response

200

application/json

Confirmation that the invoice was marked as paid.

Response object

data · MarkInvoiceAsPaidResponse · object · required

Result of marking a subscription invoice as paid.

Show child attributes