• HTTP
  • Java
  • .NET
  • PHP
  • Python
  • Ruby
  • TypeScript
  • Go
Get SDK

Read Subscription Component

API Docs by APIMATIC
Advanced Billing APIAPI EndpointsSubscription Components

Read Subscription Component
#

This request will list information regarding a specific component owned by a subscription.

GET /subscriptions/{subscription_id}/components/{component_id}.json
Authentication

This endpoint requires BasicAuth

BasicAuth
BasicAuth
Required

Set authorization parameters for BasicAuth

Required
string

The username to use with basic authentication

  • is a required field
Required
string

The password to use with basic authentication

  • is a required field

API Code Playground

Endpoint Arguments
Parameters
Required
Required
Number
Template

The Chargify id of the subscription

Required
Number
Template

The Advanced Billing id of the component. Alternatively, the component's handle prefixed by handle:

Responses

  • 200
  • 404

OK

application/json

Type

Subscription Component Response

{
  "component": {
    "component_id": 193028,
    "subscription_id": 14593192,
    "allocated_quantity": 1,
    "pricing_scheme": "per_unit",
    "name": "Users",
    "kind": "quantity_based_component",
    "unit_name": "Users",
    "price_point_id": 1,
    "price_point_handle": "top-tier",
    "enabled": true
  }
}
  • HTTP
  • Java
  • .NET
  • PHP
  • Python
  • Ruby
  • TypeScript
  • Go
  • Request
  • Response
curl -X GET \
  --url 'https://subdomain.chargify.com/subscriptions/222/components/222.json'  \
  -H 'Accept: application/json'