Update invoice payment status

amount_due

number

amount_paid

number

amount_remaining

number

billing_period

string

billing_reason

string

billing_sequence

integer

created_at

string

created_by

string

currency

string

customer

object

customer_id

string

description

string

due_date

string

finalized_at

string

id

string

idempotency_key

string

invoice_number

string

invoice_pdf_url

string

invoice_status

enum<string>

Available options:

DRAFT,

FINALIZED,

VOIDED

invoice_type

enum<string>

Available options:

SUBSCRIPTION,

ONE_OFF,

CREDIT

line_items

object[]

metadata

object

paid_at

string

payment_status

enum<string>

Available options:

PENDING,

SUCCEEDED,

FAILED

period_end

string

period_start

string

status

string

subscription

object

Edges

subscription.billing_anchor

string

BillingAnchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.

subscription.billing_cadence

any

subscription.billing_period

any

subscription.billing_period_count

integer

BillingPeriodCount is the total number units of the billing period.

subscription.cancel_at

string

CancelAt is the date the subscription will be canceled

subscription.cancel_at_period_end

boolean

CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period

subscription.cancelled_at

string

CanceledAt is the date the subscription was canceled

subscription.created_at

string

subscription.created_by

string

subscription.currency

string

Currency is the currency of the subscription in lowercase 3 digit ISO codes

subscription.current_period_end

string

CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

subscription.current_period_start

string

CurrentPeriodStart is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

subscription.customer

object

subscription.customer_id

string

CustomerID is the identifier for the customer in our system

subscription.end_date

string

EndDate is the end date of the subscription

subscription.id

string

ID is the unique identifier for the subscription

subscription.invoice_cadence

any

subscription.line_items

object[]

subscription.lookup_key

string

LookupKey is the key used to lookup the subscription in our system

subscription.metadata

object

Metadata is a map of key-value pairs that can be attached to the subscription

subscription.plan

object

subscription.plan.created_at

string

subscription.plan.created_by

string

subscription.plan.description

string

subscription.plan.entitlements

object[]

subscription.plan.entitlements.created_at

string

subscription.plan.entitlements.created_by

string

subscription.plan.entitlements.feature

object

subscription.plan.entitlements.feature_id

string

subscription.plan.entitlements.feature_type

enum<string>

Available options:

metered,

boolean,

static

subscription.plan.entitlements.id

string

subscription.plan.entitlements.is_enabled

boolean

subscription.plan.entitlements.is_soft_limit

boolean

subscription.plan.entitlements.plan

object

subscription.plan.entitlements.plan_id

string

subscription.plan.entitlements.static_value

string

subscription.plan.entitlements.status

enum<string>

Available options:

published,

deleted,

archived

subscription.plan.entitlements.tenant_id

string

subscription.plan.entitlements.updated_at

string

subscription.plan.entitlements.updated_by

string

subscription.plan.entitlements.usage_limit

integer

subscription.plan.entitlements.usage_reset_period

enum<string>

Available options:

MONTHLY,

ANNUAL,

WEEKLY,

DAILY

subscription.plan.id

string

subscription.plan.invoice_cadence

enum<string>

Available options:

ARREAR,

ADVANCE

subscription.plan.lookup_key

string

subscription.plan.name

string

subscription.plan.prices

object[]

subscription.plan.prices.amount

number

Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50

subscription.plan.prices.billing_cadence

any

subscription.plan.prices.billing_model

any

subscription.plan.prices.billing_period

any

subscription.plan.prices.billing_period_count

integer

BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12

subscription.plan.prices.created_at

string

subscription.plan.prices.created_by

string

subscription.plan.prices.currency

string

Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp

subscription.plan.prices.description

string

Description of the price

subscription.plan.prices.display_amount

string

DisplayAmount is the formatted amount with currency symbol For USD: $12.50

subscription.plan.prices.filter_values

object

FilterValues are the filter values for the price in case of usage based pricing

subscription.plan.prices.id

string

ID uuid identifier for the price

subscription.plan.prices.lookup_key

string

LookupKey used for looking up the price in the database

subscription.plan.prices.metadata

object

Metadata is a jsonb field for additional information

subscription.plan.prices.meter

object

subscription.plan.prices.meter_id

string

MeterID is the id of the meter for usage based pricing

subscription.plan.prices.plan_id

string

PlanID is the id of the plan for plan based pricing

subscription.plan.prices.status

enum<string>

Available options:

published,

deleted,

archived

subscription.plan.prices.tenant_id

string

subscription.plan.prices.tier_mode

any

subscription.plan.prices.tiers

object[]

Tiers are the tiers for the price when BillingModel is TIERED

subscription.plan.prices.transform_quantity

object

Transform is the quantity transformation in case of PACKAGE billing model

subscription.plan.prices.type

any

subscription.plan.prices.updated_at

string

subscription.plan.prices.updated_by

string

subscription.plan.status

enum<string>

Available options:

published,

deleted,

archived

subscription.plan.tenant_id

string

subscription.plan.trial_period

integer

subscription.plan.updated_at

string

subscription.plan.updated_by

string

subscription.plan_id

string

PlanID is the identifier for the plan in our system

subscription.start_date

string

StartDate is the start date of the subscription

subscription.status

enum<string>

Available options:

published,

deleted,

archived

subscription.subscription_status

any

subscription.tenant_id

string

subscription.trial_end

string

TrialEnd is the end date of the trial period

subscription.trial_start

string

TrialStart is the start date of the trial period

subscription.updated_at

string

subscription.updated_by

string

subscription.version

integer

Version is used for optimistic locking

subscription_id

string

tenant_id

string

updated_at

string

updated_by

string

version

integer

voided_at

string

API Documentation

Auth

Customers

Invoices

Wallets

Entitlements

Environments

Events

Features

Meters

Plans

Prices

Subscriptions

Tenants

Users

Update invoice payment status

Authorizations

Path Parameters

Body

Response