Skip to main content
GET
/
orgs
/
{orgId}
/
billingAccount
Get the billing account for an organization
curl --request GET \
  --url https://api.withampersand.com/v1/orgs/{orgId}/billingAccount \
  --header 'X-Api-Key: <api-key>'
{
  "id": "billing-account-123",
  "displayName": "Acme Inc",
  "billingProvider": "stripe",
  "billingProviderRef": "acct_1J2k3l4m5n6o7p8q9r0s",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
orgId
string
required

ID of the organization.

Response

Billing account

​
id
string
required

The billing account ID.

Example:

"billing-account-123"

​
displayName
string
required

The display name of the billing account.

Example:

"Acme Inc"

​
billingProvider
string
required

The billing provider that this account is associated with.

Example:

"stripe"

​
billingProviderRef
string
required

The ID used by the billing provider to identify the account.

Example:

"acct_1J2k3l4m5n6o7p8q9r0s"

​
createTime
string<date-time>

The time the billing account was created.

​
updateTime
string<date-time>

The time the billing account was last updated.