Get billing account

Get a billing account by ID.

Path Parameters

org_id string required
id string required

ID of the billing account to get

Query Parameters

with_payment_methods boolean

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

billing_account object
id string
org_id string
name string
email string
phone string
address object
line1 string
line2 string
city string
state string
postal_code string
country string
provider_id string
provider string
currency string
state string
metadata object
created_at date-time
updated_at date-time
payment_methods object[]
Array [
id string
customer_id string
provider_id string
type string
card_brand string
card_last4 string
card_expiry_month int64
card_expiry_year int64
metadata object
created_at date-time
]

{
  "billing_account": {
    "id": "string",
    "org_id": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string"
    },
    "provider_id": "string",
    "provider": "string",
    "currency": "string",
    "state": "string",
    "metadata": {},
    "created_at": "2024-01-24T15:23:30.690Z",
    "updated_at": "2024-01-24T15:23:30.690Z"
  },
  "payment_methods": [
    {
      "id": "string",
      "customer_id": "string",
      "provider_id": "string",
      "type": "string",
      "card_brand": "string",
      "card_last4": "string",
      "card_expiry_month": "string",
      "card_expiry_year": "string",
      "metadata": {},
      "created_at": "2024-01-24T15:23:30.690Z"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...