API → PaymentsList invoices for your user

Parameters

No parameters

Returns

• 200 OK

  successful operation

  Name

  Type

  Req.

  body

  array

  optional

  Array of

  • amount_due

    number / USD Price

    optional

  • amount_paid

    number / USD Price

    optional

  • amount_remaining

    number / USD Price

    optional

  • attempt_count

    integer

    optional

  • attempted

    boolean

    optional

  • billing_reason

    string

    optional

  • collection_method

    string

    optional

  • created_at

    string / ISO-8601

    optional

  • currency

    string

    optional

  • customer_email

    string / Email Address

    optional

  • customer_id

    string

    optional

  • default_payment_method

    string

    optional

  • description

    string

    optional

  • discounts

    array

    optional

    Array of

    • coupon

      object

      optional

      Object Properties

      • amount_off

        number / USD Price

        optional

      • id

        string

        optional

      • metadata

        object

        optional

      • name

        string

        optional

      • percent_off

        number

        optional

  • id

    string

    optional

  • lines

    array

    optional

    Array of

    • amount

      number / USD Price

      optional

    • currency

      string

      optional

    • description

      string

      optional

    • id

      string

      optional

    • invoice_item

      string

      optional

    • metadata

      object

      optional

  • metadata

    object

    optional

  • number

    string

    optional

  • paid

    boolean

    optional

  • pdf

    string / URL

    optional

  • receipt_number

    string

    optional

  • statement_descriptor

    string

    optional

  • status

    string

    optional

    Possible values

    • draft:  Draft.
    • open:  Open.
    • paid:  Paid.
    • uncollectible:  Uncollectible.
    • void:  Void.
    • unknown:  Unknown.

  • subscription_id

    string

    optional

  • subtotal

    number / USD Price

    optional

  • tax

    number / USD Price

    optional

  • total

    number / USD Price

    optional

  • url

    string / URL

    optional