/billing/invoices/{id}

GET

/billing/invoices/{id}

curl --request GET \
  --url https://api.chatfood.app/billing/invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer
• ApiKey

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

accountId

string format: uuid

Responses

200

OK

object

invoice

object

id

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

customer

object

id

string format: uuid

companyId

string format: uuid

nullable

accountId

string format: uuid

nullable

planId

string format: uuid

planName

string

nullable

ownerName

string

nullable

isCompany

boolean

status

string

Allowed values: Trial Active PastDue Suspended Cancelled

trialEndsAt

string format: date-time

nullable

billingEmail

string

nullable

legalName

string

nullable

taxId

string

nullable

preferredMethod

string

Allowed values: Ask Card Pix

pixDiscountBps

integer format: int32

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

lines

Array<object>

nullable

object

pageId

string format: uuid

pageName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

quantity

number format: double

billableQuantity

number format: double

unmeasured

boolean

unitPrice

number format: double

overrideKind

string

Allowed values: PercentDiscount FixedUnitPrice FixedTotal Free

amountCents

integer format: int64

object

invoice

object

id

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

customer

object

id

string format: uuid

companyId

string format: uuid

nullable

accountId

string format: uuid

nullable

planId

string format: uuid

planName

string

nullable

ownerName

string

nullable

isCompany

boolean

status

string

Allowed values: Trial Active PastDue Suspended Cancelled

trialEndsAt

string format: date-time

nullable

billingEmail

string

nullable

legalName

string

nullable

taxId

string

nullable

preferredMethod

string

Allowed values: Ask Card Pix

pixDiscountBps

integer format: int32

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

lines

Array<object>

nullable

object

pageId

string format: uuid

pageName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

quantity

number format: double

billableQuantity

number format: double

unmeasured

boolean

unitPrice

number format: double

overrideKind

string

Allowed values: PercentDiscount FixedUnitPrice FixedTotal Free

amountCents

integer format: int64

Example

{
  "invoice": {
    "status": "Open",
    "basis": "ActiveLeadsEndOfPeriod"
  },
  "customer": {
    "status": "Trial",
    "preferredMethod": "Ask"
  },
  "lines": [
    {
      "overrideKind": "PercentDiscount"
    }
  ]
}

object

invoice

object

id

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

customer

object

id

string format: uuid

companyId

string format: uuid

nullable

accountId

string format: uuid

nullable

planId

string format: uuid

planName

string

nullable

ownerName

string

nullable

isCompany

boolean

status

string

Allowed values: Trial Active PastDue Suspended Cancelled

trialEndsAt

string format: date-time

nullable

billingEmail

string

nullable

legalName

string

nullable

taxId

string

nullable

preferredMethod

string

Allowed values: Ask Card Pix

pixDiscountBps

integer format: int32

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

lines

Array<object>

nullable

object

pageId

string format: uuid

pageName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

quantity

number format: double

billableQuantity

number format: double

unmeasured

boolean

unitPrice

number format: double

overrideKind

string

Allowed values: PercentDiscount FixedUnitPrice FixedTotal Free

amountCents

integer format: int64

Example

{
  "invoice": {
    "status": "Open",
    "basis": "ActiveLeadsEndOfPeriod"
  },
  "customer": {
    "status": "Trial",
    "preferredMethod": "Ask"
  },
  "lines": [
    {
      "overrideKind": "PercentDiscount"
    }
  ]
}