Docs/User API/Pricing/Get

Get pricing

Preview

GET/user/v1/pricing

Get pricing.

query parameters

accountType
enum
Whether to get pricing for users or organizations.
This is not required if organization ID is specified and will default to user if no options are specified.
Possible values:
ORGANIZATIONUSER
organizationId
string
Show pricing for specified organization.
If this and account type are not specified, it will default to the requesting user for authenticated requests.
public
boolean
Always get the current public pricing.
For unauthenticated requests, this is always true.

Returns

plans
Plan[]
The list of plans.
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.

plans
Plan[]
The list of plans.
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.

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

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

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

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

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

Response bodyJSON

{
  "plans": [
    {
      "id": "plan_2wnGzPMSrDBYK5:ukfHizos:monthly:usd",
      "state": "AVAILABLE",
      "uniqueId": "pro:ukfHizos:monthly:usd",
      "displayName": "Pro",
      "description": "The pro plan.",
      "tier": "TIER1",
      "currencyCode": "USD",
      "interval": {
        "quantity": 1,
        "unit": "MONTH"
      },
      "revision": {
        "id": "plan_2wnGzPMSrDBYK5:ukfHizos"
      },
      "default": true,
      "trial": {
        "days": 7
      },
      "items": [
        {
          "type": "SEAT",
          "product": {
            "id": "pd_3fNK5BXs9C1Fdc",
            "uniqueId": "pro-seat",
            "displayName": "Pro seat"
          },
          "price": {
            "id": "pr_HFULbg4GRQEkV6",
            "currencyCode": "USD",
            "billingMode": "FIXED_TERM",
            "interval": {
              "quantity": 1,
              "unit": "MONTH"
            },
            "fixed": {
              "amount": "5"
            }
          }
        }
      ]
    },
    {
      "id": "plan_2wnGzPMSrDBYK5:ukfHizos:yearly:usd",
      "state": "AVAILABLE",
      "uniqueId": "pro:ukfHizos:yearly:usd",
      "displayName": "Pro",
      "description": "The pro plan.",
      "tier": "TIER1",
      "currencyCode": "USD",
      "interval": {
        "quantity": 1,
        "unit": "YEAR"
      },
      "revision": {
        "id": "plan_2wnGzPMSrDBYK5:ukfHizos"
      },
      "trial": {
        "days": 7
      },
      "savings": {
        "percentage": 16
      },
      "items": [
        {
          "type": "SEAT",
          "product": {
            "id": "pd_3fNK5BXs9C1Fdc",
            "uniqueId": "pro-seat",
            "displayName": "Pro seat"
          },
          "price": {
            "id": "pr_36La7Y1xhx2qWv",
            "currencyCode": "USD",
            "billingMode": "FIXED_TERM",
            "interval": {
              "quantity": 1,
              "unit": "YEAR"
            },
            "fixed": {
              "amount": "50"
            }
          }
        }
      ]
    }
  ]
}

PreviousThe pricing object

NextRoles

Get pricing

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

Returns

query parameters