InvoicePaymentLinkState
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Whether an invoice's payment link still opens the payment page, as reported by `linkState`.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
None |
The invoice carries no payment link. |
Live |
The link opens the payment page and accepts a payment. |
Expired |
The link's expiry has passed, so it no longer opens the payment page. |
Spent |
A payer's attempt used the link up. It no longer opens the payment page. A referral, a pending or submitted authorization and a partial approval always spend the link, because money may already have moved; a decline spends it once its retries run out, or at once when the link does not reopen after a decline. |
Revoked |
The link was withdrawn (revoked or cancelled) and no longer opens the payment page. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.