Retrieve an invoice

GET

/dashboard/v1/merchants/{merchantId}/{mode}/invoices/{id}

curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/invoices/example \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

id

required

string

Responses

200

Invoice

Media typeapplication/json

object

id

required

string

object

required

string

Allowed values: invoice

livemode

required

boolean

subscription

required

string

period_index

required

integer

period_start

required

string

period_end

required

string

amount

required

integer

currency

required

string

Allowed values: XOF

status

required

string

Allowed values: open paid void uncollectible

payment

required

Current payment attempt; a confirmed failed attempt may be replaced

string | null

hosted_invoice_url

required

Stable customer link, payable until grace_ends_at

string format: uri

due_at

required

Invoice becomes overdue after this time but remains payable during grace

string

grace_ends_at

required

string

paid_at

required

string | null

reminders_sent

required

integer

created_at

required

string

Example

{
  "object": "invoice",
  "currency": "XOF",
  "status": "open"
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}