Invoice Resource

🚧
This is an early access feature.
If you would like your account to be configured, please contact [email protected]

{
  "data":{
    "id": "inv_CbFCTDfxvMFNjwjVi26Uzhtj",
    "type": "invoice",
    "attributes": {
      "amount": 20000,
      "customer_id": "cus_CbFCTDfxvMFNjwjVi26Uzhtj",
      "currency": "PHP",
      "description": "Platinum Internet",
      "due_date": "2023-08-01",
      "livemode": true,
      "line_items": [
        {
          "id": "inv_li_CbFCTDfxvMFNjwjVi26Uzhtj",
          "amount": 10000,
          "description": "Add-on bundle",
        }
       ],
      "payment_intent": {
        "id":“pi_gpJccKuxkMZtjbQgdBkS5x22”,
        "status": "awaiting_payment_method"
      },
      "subscription": {
        "id": "subs_CbFCTDfxvMFNjwjVi26Uzhtj",
        "status": "active",
        "plan": {
          "id": "plan_dQsAFCwcrfL7WTJL6Wcv769Q",
          "amount": 10000,
          "currency": "PHP",
          "cycle_count": 5,
          "description": "Test plan without metadata",
          "interval": "monthly",
          "inverval_count": 1,
          "name": "Basic Plan",
          "created_at": 1699585219,
          "updated_at": 1699585219,
       	 },
      },
      "status": "paid",
      "created_at": 167143933,
      "updated_at": 167143933
    }
  }
}

id string
Unique ID of the resource.

type string
Represents the resource type. Value is always invoice.

amount integer
Amount to be collected from the customer. The value is the sum of all the line_items in cents.

customer_id string
ID of the Customer who is charged with the Invoice.

currency string
Three-letter ISO currency code, in uppercase. PHP is the only supported currency as of the moment.

description string
Description of the Invoice

due_date date
Date when the payment should be collected from the customer.

livemode boolean
The value is true if the resource exists in live mode or the value is false if the resource exists in test mode.

line_items.id string
Unique ID of the Invoice Line Item.

line_items.amount integer
Amount of the Invoice Line Item in cents.

line_items.description string
Description of the Invoice Line Item.

payment_intent.id string
ID of the payment intent.

payment_intent.status string
Status of the payment intent.

subscription.id string
ID of the Subscription that is linked to the Invoice.

subscription.status string
Status of the subscription

subscription.plan object
Plan details of the subscription. See plan attributes

status string
Status of the Invoice. Possible values are draft, open, paid, or void.

created_at timestamp
The date when the Invoice has been created.

updated_at timestamp
The date when the Invoice has been updated.

🚧This is an early access feature.

🚧
This is an early access feature.