Get a billing account

Preview

GET/user/v1/billingAccount

Get the default billing account.

query parameters

organizationId
string
The identifier of the organization.
If not specified the billing account for the user is returned.

Returns

state
enum
The status of the billing account.
Possible values:
USER_MANAGEDADMIN_MANAGEDUNMANAGEDBROKENNOT_SETUP
displayName
string
The human-readable display name of the billing account.
email
string
The email address of the billing account.
phoneNumber
string
The E164 phone number for the billing account (e.g. +12125550123).
address
Address
The billing address for the billing account.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
currencyCode
string
The ISO-4217 currency code for the billing account (e.g. USD).
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
checkouts
BillingAccountCheckout[]
The available checkouts.
type
enum
The type of checkout.
Possible values:
CHANGESTART_TRIALCONVERT_TRIALSTART_PAIDUPGRADE_PLANDOWNGRADE_PLANCHANGE_TERMSSWITCH_TO_MONTHLYSWITCH_TO_YEARLYCHANGE_SEATSCHANGE_PAYMENT_METHODCANCELRESTART
paymentMethods
PaymentMethod[]
The default and latest 10 payment methods for the account.
id
string
The system-assigned identifier of the payment method.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT)
Possible values:
CREDITDEBITPREPAID
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
subscription
Subscription
The subscription for the account.
id
string
The system-assigned identifier of the subscription.
state
enum
The status of the subscription.
Possible values:
TRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSEDCANCELED
currencyCode
string
The currency code for the subscription (e.g. USD).
plan
Plan
The subscription items.
id
string
The system-assigned identifier of the plan.
state
enum
The status of the plan.
Possible values:
AVAILABLEUNAVAILABLE
uniqueId
string
The client defined unique identifier of the plan.
displayName
string
The name of the plan.
description
string
The description of the plan.
tier
enum
The tier for the plan.
This is only available in checkout and pricing.
Possible values:
FREETIER1TIER2TIER3TIER4TIER5ENTERPRISE
currencyCode
string
The currency code for the plan (e.g. USD).
interval
Interval
The billing interval for the plan.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
revision
PlanRevision
The revision for the plan.
id
string
The system-assigned identifier of the plan revision.
current
boolean
Whether this is the current revision for the subscription.
This is only set in checkout.
selected
boolean
Whether this is the selected revision.
This is only set in checkout.
latest
boolean
Whether this is the latest revision for the plan.
This is only set for a current or selected plan in checkout.
current
boolean
Whether this is the current plan for the subscription.
This is only set in checkout.
selected
boolean
Whether this is the selected plan.
This is only set in checkout.
default
boolean
Whether this is the default term for the plan.
trial
PlanTrial
The trial settings.
For authenticated requests, this will only be set for accounts that are eligible for a new trial.
days
int32
The number of days in the trial.
changePath
enum
Whether the change is considered an upgrade or a downgrade.
This is only set in checkout.
Possible values:
UPGRADEDOWNGRADE
savings
PlanSavings
The savings for the plan.
The savings are in comparison to the plan in the revision with the shortest billing interval (normally monthly).
percentage
int32
The percentage savings (1-100).
This percentage is rounded down.
items
PlanItem[]
The items associated with plan.
type
enum
The plan item type.
Possible values:
PLANPLAN_ADDONSEAT
product
Product
The product associated with the item.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
price
Price
The price associated with the item.
id
string
The system-assigned identifier of the price.
currencyCode
string
The currency for the price.
billingMode
enum
The billing mode for the price.
Possible values:
FIXED_TERMUSAGE_BASED
interval
Interval
The billing interval for the price.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
fixed
PriceFixedPrice
The price is fixed per quantity.
amount
string
The decimal amount for the defined currency (e.g. 9.95).
transformQuantity
PriceTransformQuantity
Whether to transform the quantity before multiplying amount.
divisor
int32
The amount to divide the quantity by.
round
enum
Whether to round the result up or down.
Possible values:
UPDOWN
tiered
PriceTieredPrice
The price is dependent on the quantity.
mode
enum
The strategy for evaluating the tiers.
Possible values:
GRADUATEDVOLUME
tiers
PriceTieredPriceTier[]
The tiers for the price.
upper
int32
The upper quantity for tier (inclusive).
unitAmount
string
The per quantity amount for the tier.
flatAmount
string
The flat amount for the tier.
paymentMethod
PaymentMethod
The payment method.
id
string
The system-assigned identifier of the payment method.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT)
Possible values:
CREDITDEBITPREPAID
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
renewCanceled
boolean
The subscription is scheduled to be canceled at the end of the current billing period.
cancelPeriodEnd
boolean
Deprecated
The subscription is scheduled to be canceled at the end of the current billing period.
startTime
date-time
The time the subscription started.
endTime
date-time
The time the subscription ends/ended.
trial
SubscriptionTrial
The trial information for the subscription.
startTime
date-time
The time the trial started.
endTime
date-time
The time the trial ended/ends.
days
int32
The number of days in the trial.
This number is rounded to the nearest whole number of days.
remainingDays
int32
The number of days remaining in the trial.
This number is rounded down, so will generally be less than days. It will be zero on the last day of the trial and null when the trial expires.
currentPeriod
SubscriptionCurrentPeriod
The current billing period for the subscription.
startTime
date-time
The time the current billing period started.
endTime
date-time
The time the current billing period ends.
items
SubscriptionItem[]
The subscription items.
id
string
The identifier of the item.
product
Product
The details of the associated product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
price
Price
The details of the associated price.
id
string
The system-assigned identifier of the price.
currencyCode
string
The currency for the price.
billingMode
enum
The billing mode for the price.
Possible values:
FIXED_TERMUSAGE_BASED
interval
Interval
The billing interval for the price.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
fixed
PriceFixedPrice
The price is fixed per quantity.
amount
string
The decimal amount for the defined currency (e.g. 9.95).
transformQuantity
PriceTransformQuantity
Whether to transform the quantity before multiplying amount.
divisor
int32
The amount to divide the quantity by.
round
enum
Whether to round the result up or down.
Possible values:
UPDOWN
tiered
PriceTieredPrice
The price is dependent on the quantity.
mode
enum
The strategy for evaluating the tiers.
Possible values:
GRADUATEDVOLUME
tiers
PriceTieredPriceTier[]
The tiers for the price.
upper
int32
The upper quantity for tier (inclusive).
unitAmount
string
The per quantity amount for the tier.
flatAmount
string
The flat amount for the tier.
quantity
int32
The quantity for the item.
seats
SubscriptionSeatInfo[]
The information about the various seats available in the subscription.
state
enum
Whether a seat can be assigned or reserved.
Possible values:
AVAILABLEUNAVAILABLEPROVISIONABLE
stateReason
string
The code that best describes the reason for the state.
product
Product
The subscription item product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
currentQuantity
int32
The number of seats expected to be invoiced for the current billing period.
This might be less than the total quantity while a subscription change is pending or if the subscription is over-provisioned.
renewQuantity
int32
The number of seats expected at renewal.
This will only be set when different from current quantity.
assignedQuantity
int32
The number of seats currently assigned.
unassignedQuantity
int32
The number of seats not assigned.
reservedQuantity
int32
The number of seats currently reserved because of pending invitations.
These can be made available by cancelling outstanding invitations.
availableQuantity
int32
The number of seats which can be assigned or reserved.
totalQuantity
int32
The total number of seats associated with the subscription.
createTime
date-time
The creation time of the subscription.
updateTime
date-time
The last update time of the subscription.

state
enum
The status of the billing account.
Possible values:
USER_MANAGEDADMIN_MANAGEDUNMANAGEDBROKENNOT_SETUP
displayName
string
The human-readable display name of the billing account.
email
string
The email address of the billing account.
phoneNumber
string
The E164 phone number for the billing account (e.g. +12125550123).
address
Address
The billing address for the billing account.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
currencyCode
string
The ISO-4217 currency code for the billing account (e.g. USD).
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
checkouts
BillingAccountCheckout[]
The available checkouts.
type
enum
The type of checkout.
Possible values:
CHANGESTART_TRIALCONVERT_TRIALSTART_PAIDUPGRADE_PLANDOWNGRADE_PLANCHANGE_TERMSSWITCH_TO_MONTHLYSWITCH_TO_YEARLYCHANGE_SEATSCHANGE_PAYMENT_METHODCANCELRESTART
paymentMethods
PaymentMethod[]
The default and latest 10 payment methods for the account.
id
string
The system-assigned identifier of the payment method.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT)
Possible values:
CREDITDEBITPREPAID
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
subscription
Subscription
The subscription for the account.
id
string
The system-assigned identifier of the subscription.
state
enum
The status of the subscription.
Possible values:
TRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSEDCANCELED
currencyCode
string
The currency code for the subscription (e.g. USD).
plan
Plan
The subscription items.
id
string
The system-assigned identifier of the plan.
state
enum
The status of the plan.
Possible values:
AVAILABLEUNAVAILABLE
uniqueId
string
The client defined unique identifier of the plan.
displayName
string
The name of the plan.
description
string
The description of the plan.
tier
enum
The tier for the plan.
This is only available in checkout and pricing.
Possible values:
FREETIER1TIER2TIER3TIER4TIER5ENTERPRISE
currencyCode
string
The currency code for the plan (e.g. USD).
interval
Interval
The billing interval for the plan.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
revision
PlanRevision
The revision for the plan.
id
string
The system-assigned identifier of the plan revision.
current
boolean
Whether this is the current revision for the subscription.
This is only set in checkout.
selected
boolean
Whether this is the selected revision.
This is only set in checkout.
latest
boolean
Whether this is the latest revision for the plan.
This is only set for a current or selected plan in checkout.
current
boolean
Whether this is the current plan for the subscription.
This is only set in checkout.
selected
boolean
Whether this is the selected plan.
This is only set in checkout.
default
boolean
Whether this is the default term for the plan.
trial
PlanTrial
The trial settings.
For authenticated requests, this will only be set for accounts that are eligible for a new trial.
days
int32
The number of days in the trial.
changePath
enum
Whether the change is considered an upgrade or a downgrade.
This is only set in checkout.
Possible values:
UPGRADEDOWNGRADE
savings
PlanSavings
The savings for the plan.
The savings are in comparison to the plan in the revision with the shortest billing interval (normally monthly).
percentage
int32
The percentage savings (1-100).
This percentage is rounded down.
items
PlanItem[]
The items associated with plan.
type
enum
The plan item type.
Possible values:
PLANPLAN_ADDONSEAT
product
Product
The product associated with the item.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
price
Price
The price associated with the item.
id
string
The system-assigned identifier of the price.
currencyCode
string
The currency for the price.
billingMode
enum
The billing mode for the price.
Possible values:
FIXED_TERMUSAGE_BASED
interval
Interval
The billing interval for the price.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
fixed
PriceFixedPrice
The price is fixed per quantity.
amount
string
The decimal amount for the defined currency (e.g. 9.95).
transformQuantity
PriceTransformQuantity
Whether to transform the quantity before multiplying amount.
divisor
int32
The amount to divide the quantity by.
round
enum
Whether to round the result up or down.
Possible values:
UPDOWN
tiered
PriceTieredPrice
The price is dependent on the quantity.
mode
enum
The strategy for evaluating the tiers.
Possible values:
GRADUATEDVOLUME
tiers
PriceTieredPriceTier[]
The tiers for the price.
upper
int32
The upper quantity for tier (inclusive).
unitAmount
string
The per quantity amount for the tier.
flatAmount
string
The flat amount for the tier.
paymentMethod
PaymentMethod
The payment method.
id
string
The system-assigned identifier of the payment method.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT)
Possible values:
CREDITDEBITPREPAID
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
renewCanceled
boolean
The subscription is scheduled to be canceled at the end of the current billing period.
cancelPeriodEnd
boolean
Deprecated
The subscription is scheduled to be canceled at the end of the current billing period.
startTime
date-time
The time the subscription started.
endTime
date-time
The time the subscription ends/ended.
trial
SubscriptionTrial
The trial information for the subscription.
startTime
date-time
The time the trial started.
endTime
date-time
The time the trial ended/ends.
days
int32
The number of days in the trial.
This number is rounded to the nearest whole number of days.
remainingDays
int32
The number of days remaining in the trial.
This number is rounded down, so will generally be less than days. It will be zero on the last day of the trial and null when the trial expires.
currentPeriod
SubscriptionCurrentPeriod
The current billing period for the subscription.
startTime
date-time
The time the current billing period started.
endTime
date-time
The time the current billing period ends.
items
SubscriptionItem[]
The subscription items.
id
string
The identifier of the item.
product
Product
The details of the associated product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
price
Price
The details of the associated price.
id
string
The system-assigned identifier of the price.
currencyCode
string
The currency for the price.
billingMode
enum
The billing mode for the price.
Possible values:
FIXED_TERMUSAGE_BASED
interval
Interval
The billing interval for the price.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
fixed
PriceFixedPrice
The price is fixed per quantity.
amount
string
The decimal amount for the defined currency (e.g. 9.95).
transformQuantity
PriceTransformQuantity
Whether to transform the quantity before multiplying amount.
divisor
int32
The amount to divide the quantity by.
round
enum
Whether to round the result up or down.
Possible values:
UPDOWN
tiered
PriceTieredPrice
The price is dependent on the quantity.
mode
enum
The strategy for evaluating the tiers.
Possible values:
GRADUATEDVOLUME
tiers
PriceTieredPriceTier[]
The tiers for the price.
upper
int32
The upper quantity for tier (inclusive).
unitAmount
string
The per quantity amount for the tier.
flatAmount
string
The flat amount for the tier.
quantity
int32
The quantity for the item.
seats
SubscriptionSeatInfo[]
The information about the various seats available in the subscription.
state
enum
Whether a seat can be assigned or reserved.
Possible values:
AVAILABLEUNAVAILABLEPROVISIONABLE
stateReason
string
The code that best describes the reason for the state.
product
Product
The subscription item product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
currentQuantity
int32
The number of seats expected to be invoiced for the current billing period.
This might be less than the total quantity while a subscription change is pending or if the subscription is over-provisioned.
renewQuantity
int32
The number of seats expected at renewal.
This will only be set when different from current quantity.
assignedQuantity
int32
The number of seats currently assigned.
unassignedQuantity
int32
The number of seats not assigned.
reservedQuantity
int32
The number of seats currently reserved because of pending invitations.
These can be made available by cancelling outstanding invitations.
availableQuantity
int32
The number of seats which can be assigned or reserved.
totalQuantity
int32
The total number of seats associated with the subscription.
createTime
date-time
The creation time of the subscription.
updateTime
date-time
The last update time of the subscription.

curl https://api.userhub.com/user/v1/billingAccount?organizationId=org_28seyVGVL1got6 \
  -H "UserHub-Api-Key: $USERHUB_USER_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

const res = await userApi.billingAccount.get({
  organizationId: "org_28seyVGVL1got6",
});

res, err := userApi.BillingAccount().Get(
    context.Background(),
    &userapi.BillingAccountGetInput{
        OrganizationId: "org_28seyVGVL1got6",
    },
)

$res = $userApi->billingAccount->get(
    organizationId: 'org_28seyVGVL1got6',
);

res = user_api.billing_account.get(
    organization_id="org_28seyVGVL1got6",
)

Response bodyJSON

{
  "state": "USER_MANAGED",
  "checkouts": [
    {
      "type": "CHANGE"
    },
    {
      "type": "CHANGE_PAYMENT_METHOD"
    },
    {
      "type": "CANCEL"
    }
  ],
  "paymentMethods": [
    {
      "id": "pm_2kWzaZMKDM1x81",
      "type": "CARD",
      "displayName": "Visa **** 4242",
      "fullName": "Jane Doe",
      "address": {
        "lines": [
          "42 West St"
        ],
        "city": "Brooklyn",
        "state": "NY",
        "postalCode": "11222",
        "country": "US"
      },
      "default": true,
      "card": {
        "brand": "VISA",
        "expYear": 2030,
        "expMonth": 7,
        "last4": "4242",
        "fundingType": "CREDIT"
      },
      "createTime": "2025-05-15T13:00:00Z",
      "updateTime": "2025-05-15T13:00:00Z"
    }
  ],
  "subscription": {
    "id": "sub_UBUqH64iKRBdCD",
    "state": "ACTIVE",
    "currencyCode": "USD",
    "plan": {
      "id": "plan_2wnGzPMSrDBYK5:ukfHizos:monthly:usd",
      "state": "AVAILABLE",
      "uniqueId": "pro:ukfHizos:monthly:usd",
      "displayName": "Pro",
      "description": "The pro plan.",
      "currencyCode": "USD",
      "interval": {
        "quantity": 1,
        "unit": "MONTH"
      },
      "revision": {
        "id": "plan_2wnGzPMSrDBYK5:ukfHizos"
      },
      "items": [
        {
          "type": "SEAT",
          "product": {
            "id": "si_2iLgfJvq",
            "uniqueId": "pro-seat",
            "displayName": "Pro seat"
          },
          "price": {
            "id": "pr_HFULbg4GRQEkV6",
            "currencyCode": "USD",
            "billingMode": "FIXED_TERM",
            "interval": {
              "quantity": 1,
              "unit": "MONTH"
            },
            "fixed": {
              "amount": "5"
            }
          }
        }
      ]
    },
    "startTime": "2025-05-15T13:00:00Z",
    "currentPeriod": {
      "startTime": "2025-05-15T13:00:00Z",
      "endTime": "2025-06-15T13:00:00Z"
    },
    "items": [
      {
        "id": "si_2iLgfJvq",
        "product": {
          "id": "si_2iLgfJvq",
          "uniqueId": "pro-seat",
          "displayName": "Pro seat"
        },
        "price": {
          "id": "pr_HFULbg4GRQEkV6",
          "currencyCode": "USD",
          "billingMode": "FIXED_TERM",
          "interval": {
            "quantity": 1,
            "unit": "MONTH"
          },
          "fixed": {
            "amount": "5"
          }
        },
        "quantity": 1
      }
    ],
    "seats": [
      {
        "state": "PROVISIONABLE",
        "product": {
          "id": "si_2iLgfJvq",
          "uniqueId": "pro-seat",
          "displayName": "Pro seat"
        },
        "currentQuantity": 1,
        "assignedQuantity": 1,
        "unassignedQuantity": 0,
        "totalQuantity": 1
      }
    ],
    "createTime": "2025-05-15T13:00:00Z",
    "updateTime": "2025-05-15T13:00:00Z"
  }
}

PreviousThe billing account object

NextUpdate a billing account

Get a billing account

.css-10iahqc{text-transform:capitalize;}query parameters

Returns

query parameters