Retrieve a LicensedItem v2

Retrieve a LicensedItem object.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    ID of the LicensedItem to retrieve.

Returns

Response attributes

  • idstring

    The ID of the LicensedItem.

  • objectstring, value is "v2.billing.licensed_item"

    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.

  • display_namestring

    Description that customers will see in the invoice line item. Maximum length of 250 characters.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • lookup_keynullable string

    An internal key you can use to search for a particular billable item. Maximum length of 200 characters.

  • metadatanullable map

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • tax_detailsnullable objectPreview feature

    Stripe Tax details.

  • unit_labelnullable string

    The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field to “seat” for Checkout to display “(price) per seat”, or “environment” to display “(price) per environment”. Maximum length of 100 characters.

Error Codes
404licensed_item_not_found

Returned when the provided licensed_item ID cannot be found.

GET /v2/billing/licensed_items/:id
curl https://api.stripe.com/v2/billing/licensed_items/bli_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy \
-H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
-H "Stripe-Version: 2025-07-30.preview"
Response
{
"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
}

List LicensedItems v2

List all LicensedItem objects in reverse chronological order of creation.

Learn more about calling API v2 endpoints.

Parameters

  • limitinteger

    Optionally set the maximum number of results per page. Defaults to 20.

  • pagestring

    Opaque page token.

Returns

Response attributes

  • dataarray of objects

    The retrieved LicensedItem objects.

  • next_page_urlnullable string

    The URL of the next page of results, if there is one.

  • previous_page_urlnullable string

    The URL of the previous page of results, if there is one.

GET /v2/billing/licensed_items
curl https://api.stripe.com/v2/billing/licensed_items \
-H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
-H "Stripe-Version: 2025-07-30.preview"
Response
{
"data": [
{
"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
}
],
"next_page_url": null,
"previous_page_url": null
}

Service Actions v2

A ServiceAction represents a recurring, automated action that can be applied as part of a subscription.

Rate Card Subscriptions v2

A RateCardSubscription links a RateCard to a specific billing Cadence. While the RateCardSubscription is active, Stripe will bill the Payer according to the RateCard’s pricing.