Get billing account

Get a billing account by ID.

Path Parameters

orgId string required
id string required

ID of the billing account to get

Query Parameters

withPaymentMethods boolean

Responses

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

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

billingAccount object
id string
orgId string
name string
email string
phone string
address object
line1 string
line2 string
city string
state string
postalCode string
country string
providerId string
provider string
currency string
state string
metadata object
createdAt date-time
updatedAt date-time
paymentMethods object[]
Array [
id string
customerId string
providerId string
type string
cardBrand string
cardLast4 string
cardExpiryMonth int64
cardExpiryYear int64
metadata object
createdAt date-time
]

{
  "billingAccount": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "providerId": "string",
    "provider": "string",
    "currency": "string",
    "state": "string",
    "metadata": {},
    "createdAt": "2024-01-01T17:13:19.588Z",
    "updatedAt": "2024-01-01T17:13:19.588Z"
  },
  "paymentMethods": [
    {
      "id": "string",
      "customerId": "string",
      "providerId": "string",
      "type": "string",
      "cardBrand": "string",
      "cardLast4": "string",
      "cardExpiryMonth": "string",
      "cardExpiryYear": "string",
      "metadata": {},
      "createdAt": "2024-01-01T17:13:19.588Z"
    }
  ]
}

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...