Retrieve a LicenseFeeVersion object.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the version to retrieve.
- license_
fee_ idstringRequired The ID of the License fee object.
Returns
Response attributes
- idstring
The ID of the LicenseFeeVersion.
- objectstring, value is "v2.billing.license_fee_version"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Timestamp of when the object was created.
- license_
fee_ idstring The ID of the parent LicenseFee.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - tiering_
modenullable enum Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if
tiers
is set.Possible enum valuesgraduated
Use graduated tiering: the pricing at each tier applies to the quantity within that tier.
volume
Use volume-based tiering: the maximum quantity within a period determines the per-unit price for that period.
- tiersarray of objects
Each element represents a pricing tier. Cannot be set if
unit_
is provided.amount - transform_
quantitynullable object Apply a transformation to the reported usage or set quantity before computing the amount billed.
- unit_
amountnullable string The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if
tiers
is provided.
Returned when the provided license_fee ID cannot be found.
Returned when the provided license_fee_version ID cannot be found.
{ "created": "2025-01-01T00:00:00.000Z", "id": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "license_fee_id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "object": "v2.billing.license_fee_version", "unit_amount": "20.00", "tiers": [], "livemode": true}
List all LicenseFee objects.
Learn more about calling API v2 endpoints.Parameters
- lookup_
keysarray of stringsRequired Filter by lookup keys. You can specify up to 10 lookup keys.
- licensed_
itemstring Filter by licensed item.
- limitinteger
Optionally set the maximum number of results per page. Defaults to 20.
- pagestring
A cursor for use in pagination.
Returns
Response attributes
- dataarray of objects
List of LicenseFees.
- next_
page_ urlnullable string The URL to get the next page of results, if there are any.
- previous_
page_ urlnullable string The URL to get the previous page of results, if there are any.
{ "data": [ { "active": true, "created": "2025-01-01T00:00:00.000Z", "currency": "usd", "display_name": "Monthly fee", "id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "latest_version": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "licensed_item": { "created": "2025-01-01T00:00:00.000Z", "display_name": "Monthly fee item", "id": "bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "lookup_key": "monthly-fee-item", "metadata": { "key": "value" }, "object": "v2.billing.licensed_item", "unit_label": "per month", "livemode": true }, "live_version": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "lookup_key": "monthly-fee", "metadata": { "key": "value" }, "object": "v2.billing.license_fee", "service_interval": "month", "service_interval_count": 1, "tax_behavior": "exclusive", "tiers": [], "unit_amount": "20.00", "livemode": true } ], "next_page_url": null, "previous_page_url": null}
List all versions of a LicenseFee objects.
Learn more about calling API v2 endpoints.Parameters
- license_
fee_ idstringRequired The ID of the LicenseFee to list versions for.
- limitinteger
Optionally set the maximum number of results per page. Defaults to 20.
- pagestring
A cursor for use in pagination.
Returns
Response attributes
- dataarray of objects
List of LicenseFeeVersions.
- next_
page_ urlnullable string The URL to get the next page of results, if there are any.
- previous_
page_ urlnullable string The URL to get the previous page of results, if there are any.
Returned when the provided license_fee ID cannot be found.
{ "data": [ { "created": "2025-01-01T00:00:00.000Z", "id": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "license_fee_id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "object": "v2.billing.license_fee_version", "unit_amount": "20.00", "tiers": [], "livemode": true } ], "next_page_url": null, "previous_page_url": null}
A MeteredItem represents any item that you bill customers for based on how much they use it, such as hourly cloud CPU usage or tokens generated by an AI service.
The Custom Pricing Unit object.