Skip to main content
POST
billing.subscription-invoice.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
invoiceId
string
required

Invoice ID from billing.subscription-invoices.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

invoiceId
string
required

Your subscription invoice ID.

transactionId
string
required

Charge ID usable for refunds.

subscriptionId
string
required

Subscription ID.

status
enum<string>
required

Invoice state.

Available options:
pending,
paid,
void,
refunded,
partial_refund,
unknown
billingReason
enum<string>
required

Reason for the charge.

Available options:
initial,
renewal,
updated,
unknown
total
object
required

Gross charged total.

customerId
string

Customer ID.

name
string

Customer name.

email
string

Customer email.

subtotal
object

Subtotal.

discountTotal
object

Discount amount.

tax
object

Tax amount.

taxInclusive
boolean

Tax included in prices.

refunded
boolean

Fully refunded.

refundedAmount
object

Cumulative refunded amount.

refundedAt
string

Recorded full refund time, when known.

createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last update, ISO 8601.