Skip to content

components.md

Latest commit

 

History

History
1336 lines (1082 loc) · 43.5 KB

components.md

File metadata and controls

1336 lines (1082 loc) · 43.5 KB
Raw

Components

components_controller = client.components

Class Name

ComponentsController

Methods

Create Metered Component

Creates a metered component definition under the specified product family. A metered component can then be added and “allocated” for a subscription.

Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Ads clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes.

Note that this is different from recurring quantity-based components, which DO NOT reset to zero at the start of every billing period. If you want to bill for a quantity of something that does not change unless you change it, then you want quantity components, instead.

Hybrid Pricing

A volume, tiered, or stairstep metered component can combine its primary pricing with a secondary pricing model (the overage_pricing parameter) so both bill as a single invoice line item instead of two. This does not apply to metered components configured for event-based billing (metric, meter, or formula). See Hybrid Pricing for requirements and configuration details.

For more information on components, see our documentation here.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code. Sending "tax_code": "" returns 422.

def create_metered_component(self,
                            product_family_id,
                            body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id str Template, Required Either the product family's id or its handle prefixed with handle:
body CreateMeteredComponent Body, Optional -

Response Type

201: Created

ComponentResponse

Example Usage

product_family_id = 'product_family_id4'

body = CreateMeteredComponent(
    metered_component=MeteredComponent(
        name='Text messages',
        unit_name='text message',
        pricing_scheme=PricingScheme.PER_UNIT,
        taxable=False,
        prices=[
            Price(
                starting_quantity=1,
                unit_price=1
            )
        ]
    )
)

result = components_controller.create_metered_component(
    product_family_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 292609,
    "name": "Text messages",
    "handle": "text-messages",
    "pricing_scheme": "per_unit",
    "unit_name": "unit",
    "unit_price": "10.0",
    "product_family_id": 528484,
    "product_family_name": "Cloud Compute Servers",
    "price_per_unit_in_cents": null,
    "kind": "metered_component",
    "archived": false,
    "taxable": false,
    "description": null,
    "default_price_point_id": 2944263,
    "prices": [
      {
        "id": 55423,
        "component_id": 30002,
        "starting_quantity": 1,
        "ending_quantity": null,
        "unit_price": "10.0",
        "price_point_id": 2944263,
        "formatted_unit_price": "$10.00",
        "segment_id": null
      }
    ],
    "price_point_count": 1,
    "price_points_url": "https://demo-3238403362.chargify.com/components/30002/price_points",
    "default_price_point_name": "Original",
    "tax_code": null,
    "recurring": false,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2024-01-23T06:08:05-05:00",
    "updated_at": "2024-01-23T06:08:05-05:00",
    "archived_at": null,
    "hide_date_range_on_invoice": false,
    "allow_fractional_quantities": false,
    "use_site_exchange_rate": true,
    "item_category": null,
    "accounting_code": null
  }
}

Errors

HTTP Status Code Error Description Exception Class
404 Not Found APIException
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Create Quantity Based Component

Creates a Quantity Based component definition under the specified product family. A Quantity Based component can then be added and “allocated” for a subscription.

When defining a Quantity Based component, you can choose one of two types:

Recurring

Recurring quantity-based components are used to bill for the number of some unit (think monthly software user licenses or the number of pairs of socks in a box-a-month club). This is most commonly associated with billing for user licenses, number of users, number of employees, etc.

One-time

One-time quantity-based components are used to create ad hoc usage charges that do not recur. For example, at the time of signup, you might want to charge your customer a one-time fee for onboarding or other services.

The allocated quantity for one-time quantity-based components immediately gets reset back to zero after the allocation is made.

For more information, see Components Overview.

Hybrid Pricing

A volume, tiered, or stairstep component can combine its primary pricing with a secondary pricing model (the overage_pricing parameter) so both bill as a single invoice line item instead of two. See Hybrid Pricing for requirements and configuration details.

For more information on components, see our documentation here.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code. Sending "tax_code": "" returns 422.

def create_quantity_based_component(self,
                                   product_family_id,
                                   body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id str Template, Required Either the product family's id or its handle prefixed with handle:
body CreateQuantityBasedComponent Body, Optional -

Response Type

201: Created

ComponentResponse

Example Usage

product_family_id = 'product_family_id4'

body = CreateQuantityBasedComponent(
    quantity_based_component=QuantityBasedComponent(
        name='Quantity Based Component',
        unit_name='Component',
        pricing_scheme=PricingScheme.PER_UNIT,
        description='Example of JSON per-unit component example',
        taxable=True,
        unit_price='10',
        display_on_hosted_page=True,
        allow_fractional_quantities=True,
        public_signup_page_ids=[
            323397
        ]
    )
)

result = components_controller.create_quantity_based_component(
    product_family_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 292609,
    "name": "Text messages",
    "handle": "text-messages",
    "pricing_scheme": "per_unit",
    "unit_name": "unit",
    "unit_price": "10.0",
    "product_family_id": 528484,
    "product_family_name": "Cloud Compute Servers",
    "price_per_unit_in_cents": null,
    "kind": "quantity_based_component",
    "archived": false,
    "taxable": false,
    "description": null,
    "default_price_point_id": 2944263,
    "prices": [
      {
        "id": 55423,
        "component_id": 30002,
        "starting_quantity": 1,
        "ending_quantity": null,
        "unit_price": "10.0",
        "price_point_id": 2944263,
        "formatted_unit_price": "$10.00",
        "segment_id": null
      }
    ],
    "price_point_count": 1,
    "price_points_url": "https://demo-3238403362.chargify.com/components/30002/price_points",
    "default_price_point_name": "Original",
    "tax_code": null,
    "recurring": false,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2024-01-23T06:08:05-05:00",
    "updated_at": "2024-01-23T06:08:05-05:00",
    "archived_at": null,
    "hide_date_range_on_invoice": false,
    "allow_fractional_quantities": false,
    "use_site_exchange_rate": true,
    "item_category": null,
    "accounting_code": null
  }
}

Errors

HTTP Status Code Error Description Exception Class
404 Not Found APIException
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Create On Off Component

Creates an On/Off component definition under the specified product family. An On/Off component can then be added and “allocated” for a subscription.

On/off components are used for any flat fee, recurring add on (think $99/month for tech support or a flat add on shipping fee).

For more information on components, see our documentation here.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code. Sending "tax_code": "" returns 422.

def create_on_off_component(self,
                           product_family_id,
                           body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id str Template, Required Either the product family's id or its handle prefixed with handle:
body CreateOnOffComponent Body, Optional -

Response Type

201: Created

ComponentResponse

Example Usage

product_family_id = 'product_family_id4'

body = CreateOnOffComponent(
    on_off_component=OnOffComponent(
        name='Annual Support Services',
        unit_price='100.00',
        description='Prepay for support services',
        taxable=True,
        display_on_hosted_page=True,
        public_signup_page_ids=[
            320495
        ]
    )
)

result = components_controller.create_on_off_component(
    product_family_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 292609,
    "name": "Test On-Off Component 46124",
    "handle": "test-on-off-component-4612422802",
    "pricing_scheme": null,
    "unit_name": "on/off",
    "unit_price": "10.0",
    "product_family_id": 528484,
    "product_family_name": "Cloud Compute Servers",
    "price_per_unit_in_cents": null,
    "kind": "on_off_component",
    "archived": false,
    "taxable": false,
    "description": null,
    "default_price_point_id": 2944263,
    "price_point_count": 1,
    "price_points_url": "https://demo-3238403362.chargify.com/components/30002/price_points",
    "default_price_point_name": "Original",
    "tax_code": null,
    "recurring": true,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2024-01-23T06:08:05-05:00",
    "updated_at": "2024-01-23T06:08:05-05:00",
    "archived_at": null,
    "hide_date_range_on_invoice": false,
    "allow_fractional_quantities": false,
    "use_site_exchange_rate": true,
    "item_category": null,
    "accounting_code": null
  }
}

Errors

HTTP Status Code Error Description Exception Class
404 Not Found APIException
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Create Prepaid Usage Component

Creates a prepaid usage component definition under the specified product family. A prepaid component can then be added and “allocated” for a subscription.

Prepaid components allow customers to pre-purchase units that can be used up over time on their subscription. In a sense, they are the mirror image of metered components; while metered components charge at the end of the period for the amount of units used, prepaid components are charged for at the time of purchase, and usage is subsequently tracked against the amount purchased.

For more information, see Components Overview.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code; sending a blank value results in a validation error.

def create_prepaid_usage_component(self,
                                  product_family_id,
                                  body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id str Template, Required Either the product family's id or its handle prefixed with handle:
body CreatePrepaidComponent Body, Optional -

Response Type

201: Created

ComponentResponse

Example Usage

product_family_id = 'product_family_id4'

body = CreatePrepaidComponent(
    prepaid_usage_component=PrepaidUsageComponent(
        name='Minutes',
        unit_name='minutes',
        pricing_scheme=PricingScheme.PER_UNIT,
        overage_pricing=OveragePricing(
            pricing_scheme=PricingScheme.STAIRSTEP,
            prices=[
                Price(
                    starting_quantity=1,
                    unit_price=3,
                    ending_quantity=100
                ),
                Price(
                    starting_quantity=101,
                    unit_price=5
                )
            ]
        ),
        unit_price=2,
        rollover_prepaid_remainder=True,
        renew_prepaid_allocation=True,
        expiration_interval=15,
        expiration_interval_unit=ExpirationIntervalUnit.DAY
    )
)

result = components_controller.create_prepaid_usage_component(
    product_family_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 292609,
    "name": "Test Prepaid Component 98505",
    "handle": "test-prepaid-component-9850584842",
    "pricing_scheme": "per_unit",
    "unit_name": "unit",
    "unit_price": "10.0",
    "product_family_id": 528484,
    "product_family_name": "Test Product Family 27791",
    "price_per_unit_in_cents": null,
    "kind": "prepaid_usage_component",
    "archived": false,
    "taxable": false,
    "description": "Description for: Test Prepaid Component 98505",
    "default_price_point_id": 2944263,
    "overage_prices": [
      {
        "id": 55964,
        "component_id": 30427,
        "starting_quantity": 1,
        "ending_quantity": null,
        "unit_price": "1.0",
        "price_point_id": 2944756,
        "formatted_unit_price": "$1.00",
        "segment_id": null
      }
    ],
    "prices": [
      {
        "id": 55963,
        "component_id": 30427,
        "starting_quantity": 1,
        "ending_quantity": null,
        "unit_price": "1.0",
        "price_point_id": 2944756,
        "formatted_unit_price": "$1.00",
        "segment_id": null
      }
    ],
    "price_point_count": 1,
    "price_points_url": "https://demo-3238403362.chargify.com/components/30002/price_points",
    "default_price_point_name": "Original",
    "tax_code": null,
    "recurring": true,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2024-01-23T06:08:05-05:00",
    "updated_at": "2024-01-23T06:08:05-05:00",
    "archived_at": null,
    "hide_date_range_on_invoice": false,
    "allow_fractional_quantities": false,
    "use_site_exchange_rate": true,
    "item_category": null,
    "accounting_code": null
  }
}

Errors

HTTP Status Code Error Description Exception Class
404 Not Found APIException
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Create Event Based Component

Creates an event-based component definition under the specified product family. An event-based component can then be added and “allocated” for a subscription.

Event-based components are similar to other component types, in that you define the component parameters (such as name and taxability) and the pricing. A key difference for the event-based component is that it must be attached to a metric. This is because the metric provides the component with the actual quantity used in computing what and how much will be billed each period for each subscription.

So, instead of reporting usage directly for each component (as you would with metered components), the usage is derived from analysis of your events.

For more information, see Components Overview.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code; sending a blank value results in a validation error.

def create_event_based_component(self,
                                product_family_id,
                                body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id str Template, Required Either the product family's id or its handle prefixed with handle:
body CreateEBBComponent Body, Optional -

Response Type

201: Created

ComponentResponse

Example Usage

product_family_id = 'product_family_id4'

body = CreateEBBComponent(
    event_based_component=EBBComponent(
        name='Component Name',
        unit_name='string',
        pricing_scheme=PricingScheme.PER_UNIT,
        event_based_billing_metric_id=123,
        description='string',
        handle='some_handle',
        taxable=True,
        prices=[
            Price(
                starting_quantity=1,
                unit_price='0.49'
            )
        ]
    )
)

result = components_controller.create_event_based_component(
    product_family_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 1489581,
    "name": "stripeCharges",
    "handle": null,
    "pricing_scheme": null,
    "unit_name": "charge",
    "unit_price": null,
    "product_family_id": 1517093,
    "product_family_name": "Billing Plans",
    "price_per_unit_in_cents": null,
    "kind": "event_based_component",
    "archived": false,
    "taxable": false,
    "description": null,
    "default_price_point_id": null,
    "price_point_count": 0,
    "price_points_url": "https://staging.chargify.com/components/1489581/price_points",
    "default_price_point_name": "Original",
    "tax_code": null,
    "recurring": false,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2021-10-12T07:33:24-05:00",
    "updated_at": "2021-10-12T07:33:24-05:00",
    "archived_at": null,
    "hide_date_range_on_invoice": false,
    "allow_fractional_quantities": false,
    "use_site_exchange_rate": null,
    "item_category": null,
    "accounting_code": null,
    "event_based_billing_metric_id": 1163
  }
}

Errors

HTTP Status Code Error Description Exception Class
404 Not Found APIException
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Find Component

Returns information for a component matching the provided handle. You can identify your components with a handle so you don't have to save or reference the IDs we generate.

def find_component(self,
                  handle)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
handle str Query, Required The handle of the component to find

Response Type

200: OK

ComponentResponse

Example Usage

handle = 'handle6'

result = components_controller.find_component(handle)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 399853,
    "name": "Annual Support Services",
    "pricing_scheme": null,
    "unit_name": "on/off",
    "unit_price": "100.0",
    "product_family_id": 997233,
    "price_per_unit_in_cents": null,
    "kind": "on_off_component",
    "archived": false,
    "taxable": true,
    "description": "Prepay for support services",
    "default_price_point_id": 121003,
    "price_point_count": 4,
    "price_points_url": "https://general-goods.chargify.com/components/399853/price_points",
    "tax_code": "D0000000",
    "recurring": true,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2019-08-02T05:54:53-04:00",
    "default_price_point_name": "Original",
    "product_family_name": "Chargify"
  }
}

Read Component

Returns information regarding a component from a specific product family.

You can read the component by either the component's id or handle. When using the handle, it must be prefixed with handle:.

def read_component(self,
                  product_family_id,
                  component_id)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id int Template, Required The Advanced Billing id of the product family to which the component belongs
component_id str Template, Required Either the Advanced Billing id of the component or the handle for the component prefixed with handle:

Constraints: Pattern: /\A(?:\d+|handle:(?:uuid:|[a-z])(?:\w|-)+)\z/

Response Type

200: OK

ComponentResponse

Example Usage

product_family_id = 140

component_id = 'component_id8'

result = components_controller.read_component(
    product_family_id,
    component_id
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 399853,
    "name": "Annual Support Services",
    "pricing_scheme": null,
    "unit_name": "on/off",
    "unit_price": "100.0",
    "product_family_id": 997233,
    "price_per_unit_in_cents": null,
    "kind": "on_off_component",
    "archived": false,
    "taxable": true,
    "description": "Prepay for support services",
    "default_price_point_id": 121003,
    "price_point_count": 4,
    "price_points_url": "https://general-goods.chargify.com/components/399853/price_points",
    "tax_code": "D0000000",
    "recurring": true,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2019-08-02T05:54:53-04:00",
    "default_price_point_name": "Original",
    "product_family_name": "Chargify",
    "product_family_handle": "chargify"
  }
}

Update Product Family Component

Updates a component from a specific product family.

You may read the component by either the component's id or handle. When using the handle, it must be prefixed with handle:.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code. Sending "tax_code": "" returns 422.

def update_product_family_component(self,
                                   product_family_id,
                                   component_id,
                                   body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id int Template, Required The Advanced Billing id of the product family to which the component belongs
component_id str Template, Required Either the Advanced Billing id of the component or the handle for the component prefixed with handle:

Constraints: Pattern: /\A(?:\d+|handle:(?:uuid:|[a-z])(?:\w|-)+)\z/
body UpdateComponentRequest Body, Optional -

Response Type

200: OK

ComponentResponse

Example Usage

product_family_id = 140

component_id = 'component_id8'

body = UpdateComponentRequest(
    component=UpdateComponent(
        item_category=ItemCategory.ENUM_BUSINESS_SOFTWARE
    )
)

result = components_controller.update_product_family_component(
    product_family_id,
    component_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 399853,
    "name": "Annual Support Services",
    "pricing_scheme": null,
    "unit_name": "on/off",
    "unit_price": "100.0",
    "product_family_id": 997233,
    "price_per_unit_in_cents": null,
    "kind": "on_off_component",
    "archived": false,
    "taxable": true,
    "description": "Prepay for support services",
    "default_price_point_id": 121003,
    "price_point_count": 4,
    "price_points_url": "https://general-goods.chargify.com/components/399853/price_points",
    "tax_code": "D0000000",
    "recurring": true,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2019-08-02T05:54:53-04:00",
    "default_price_point_name": "Original",
    "product_family_name": "Chargify"
  }
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Archive Component

Archives the component; all current subscribers will continue to be charged as usual.

def archive_component(self,
                     product_family_id,
                     component_id)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id int Template, Required The Advanced Billing id of the product family to which the component belongs
component_id str Template, Required Either the Advanced Billing id of the component or the handle for the component prefixed with handle:

Constraints: Pattern: /\A(?:\d+|handle:(?:uuid:|[a-z])(?:\w|-)+)\z/

Response Type

200: OK

Component

Example Usage

product_family_id = 140

component_id = 'component_id8'

result = components_controller.archive_component(
    product_family_id,
    component_id
)
print(result)

Example Response (as JSON)

{
  "id": 25407138,
  "name": "cillum aute",
  "pricing_scheme": "stairstep",
  "unit_name": "nulla in",
  "unit_price": "Excepteur veniam",
  "product_family_id": -56705047,
  "kind": "prepaid_usage_component",
  "archived": true,
  "taxable": false,
  "description": "reprehenderit laborum qui fugiat",
  "default_price_point_id": -64328176,
  "price_point_count": 15252407,
  "price_points_url": "dolor mollit consequat",
  "tax_code": "ea nisi",
  "recurring": false,
  "created_at": "2016-11-08T16:22:26-05:00",
  "default_price_point_name": "cupidatat Lorem non aliqua",
  "product_family_name": "do elit",
  "hide_date_range_on_invoice": false
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException

List Components

Lists components for a site.

def list_components(self,
                   options=dict())

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
date_field BasicDateField Query, Optional The type of filter you would like to apply to your search.
start_date str Query, Optional The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
end_date str Query, Optional The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
start_datetime str Query, Optional The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date.
end_datetime str Query, Optional The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date.
include_archived bool Query, Optional Include archived items.
page int Query, Optional Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.

Default: 1

Constraints: >= 1
per_page int Query, Optional This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.

Default: 20

Constraints: <= 200
filter ListComponentsFilter Query, Optional Filter to use for List Components operations

Response Type

200: OK

List[ComponentResponse]

Example Usage

collect = {
    'date_field': BasicDateField.UPDATED_AT,
    'page': 1,
    'per_page': 50,
    'filter': ListComponentsFilter(
        ids=[
            1,
            2,
            3
        ]
    )
}
result = components_controller.list_components(collect)
print(result)

Example Response (as JSON)

[
  {
    "component": {
      "id": 399850,
      "name": "$1.00 component",
      "pricing_scheme": "per_unit",
      "unit_name": "Component",
      "unit_price": "1.0",
      "product_family_id": 997233,
      "price_per_unit_in_cents": null,
      "kind": "quantity_based_component",
      "archived": false,
      "taxable": false,
      "description": "Component",
      "default_price_point_id": 121000,
      "prices": [
        {
          "id": 630687,
          "component_id": 399850,
          "starting_quantity": 1,
          "ending_quantity": null,
          "unit_price": "1.0",
          "price_point_id": 121000,
          "formatted_unit_price": "$1.00"
        }
      ],
      "price_point_count": 2,
      "price_points_url": "https://general-goods.chargify.com/components/399850/price_points",
      "tax_code": null,
      "recurring": true,
      "upgrade_charge": null,
      "downgrade_credit": null,
      "created_at": "2019-08-01T09:35:38-04:00",
      "default_price_point_name": "Original",
      "product_family_name": "Chargify",
      "product_family_handle": "chargify",
      "use_site_exchange_rate": true
    }
  },
  {
    "component": {
      "id": 399853,
      "name": "Annual Support Services",
      "pricing_scheme": null,
      "unit_name": "on/off",
      "unit_price": "100.0",
      "product_family_id": 997233,
      "price_per_unit_in_cents": null,
      "kind": "on_off_component",
      "archived": false,
      "taxable": true,
      "description": "Prepay for support services",
      "default_price_point_id": 121003,
      "price_point_count": 4,
      "price_points_url": "https://general-goods.chargify.com/components/399853/price_points",
      "tax_code": "D0000000",
      "recurring": true,
      "upgrade_charge": null,
      "downgrade_credit": null,
      "created_at": "2019-08-01T09:35:37-04:00",
      "default_price_point_name": "Original",
      "product_family_name": "Chargify",
      "product_family_handle": "chargify",
      "use_site_exchange_rate": true
    }
  },
  {
    "component": {
      "id": 386937,
      "name": "Cancellation fee",
      "pricing_scheme": null,
      "unit_name": "on/off",
      "unit_price": "35.0",
      "product_family_id": 997233,
      "price_per_unit_in_cents": null,
      "kind": "on_off_component",
      "archived": false,
      "taxable": false,
      "description": "",
      "default_price_point_id": 108307,
      "price_point_count": 1,
      "price_points_url": "https://general-goods.chargify.com/components/386937/price_points",
      "tax_code": null,
      "recurring": true,
      "upgrade_charge": null,
      "downgrade_credit": null,
      "created_at": "2019-08-01T09:35:38-04:00",
      "default_price_point_name": "Original",
      "product_family_name": "Chargify",
      "product_family_handle": "chargify",
      "use_site_exchange_rate": true
    }
  }
]

Update Component

Updates a component.

You may read the component by either the component's id or handle. When using the handle, it must be prefixed with handle:.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code. Sending "tax_code": "" returns 422.

def update_component(self,
                    component_id,
                    body=None)

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
component_id str Template, Required The id or handle of the component
body UpdateComponentRequest Body, Optional -

Response Type

200: OK

ComponentResponse

Example Usage

component_id = 'component_id8'

body = UpdateComponentRequest(
    component=UpdateComponent(
        item_category=ItemCategory.ENUM_BUSINESS_SOFTWARE
    )
)

result = components_controller.update_component(
    component_id,
    body=body
)
print(result)

Example Response (as JSON)

{
  "component": {
    "id": 399853,
    "name": "Annual Support Services",
    "pricing_scheme": null,
    "unit_name": "on/off",
    "unit_price": "100.0",
    "product_family_id": 997233,
    "price_per_unit_in_cents": null,
    "kind": "on_off_component",
    "archived": false,
    "taxable": true,
    "description": "Prepay for support services",
    "default_price_point_id": 121003,
    "price_point_count": 4,
    "price_points_url": "https://general-goods.chargify.com/components/399853/price_points",
    "tax_code": "D0000000",
    "recurring": true,
    "upgrade_charge": null,
    "downgrade_credit": null,
    "created_at": "2019-08-02T05:54:53-04:00",
    "default_price_point_name": "Original",
    "product_family_name": "Chargify"
  }
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException

List Components for Product Family

Lists components for a particular product family.

def list_components_for_product_family(self,
                                      options=dict())

Authentication

This endpoint requires BasicAuth

Parameters

Parameter Type Tags Description
product_family_id int Template, Required The Advanced Billing id of the product family
include_archived bool Query, Optional Include archived items.
page int Query, Optional Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.

Default: 1

Constraints: >= 1
per_page int Query, Optional This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.

Default: 20

Constraints: <= 200
filter ListComponentsFilter Query, Optional Filter to use for List Components operations
date_field BasicDateField Query, Optional The type of filter you would like to apply to your search. Use in query date_field=created_at.
end_date str Query, Optional The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
end_datetime str Query, Optional The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date.
start_date str Query, Optional The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
start_datetime str Query, Optional The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date.

Response Type

200: OK

List[ComponentResponse]

Example Usage

collect = {
    'product_family_id': 140,
    'page': 1,
    'per_page': 50,
    'filter': ListComponentsFilter(
        ids=[
            1,
            2,
            3
        ]
    ),
    'date_field': BasicDateField.UPDATED_AT
}
result = components_controller.list_components_for_product_family(collect)
print(result)

Example Response (as JSON)

[
  {
    "component": {
      "id": 399850,
      "name": "$1.00 component",
      "pricing_scheme": "per_unit",
      "unit_name": "Component",
      "unit_price": "1.0",
      "product_family_id": 997233,
      "price_per_unit_in_cents": null,
      "kind": "quantity_based_component",
      "archived": false,
      "taxable": false,
      "description": "Component",
      "default_price_point_id": 121000,
      "prices": [
        {
          "id": 630687,
          "component_id": 399850,
          "starting_quantity": 1,
          "ending_quantity": null,
          "unit_price": "1.0",
          "price_point_id": 121000,
          "formatted_unit_price": "$1.00"
        }
      ],
      "price_point_count": 2,
      "price_points_url": "https://general-goods.chargify.com/components/399850/price_points",
      "tax_code": null,
      "recurring": true,
      "upgrade_charge": null,
      "downgrade_credit": null,
      "created_at": "2019-08-01T09:35:38-04:00",
      "default_price_point_name": "Original",
      "product_family_name": "Chargify",
      "use_site_exchange_rate": true
    }
  },
  {
    "component": {
      "id": 399853,
      "name": "Annual Support Services",
      "pricing_scheme": null,
      "unit_name": "on/off",
      "unit_price": "100.0",
      "product_family_id": 997233,
      "price_per_unit_in_cents": null,
      "kind": "on_off_component",
      "archived": false,
      "taxable": true,
      "description": "Prepay for support services",
      "default_price_point_id": 121003,
      "price_point_count": 4,
      "price_points_url": "https://general-goods.chargify.com/components/399853/price_points",
      "tax_code": "D0000000",
      "recurring": true,
      "upgrade_charge": null,
      "downgrade_credit": null,
      "created_at": "2019-08-01T09:35:37-04:00",
      "default_price_point_name": "Original",
      "product_family_name": "Chargify",
      "use_site_exchange_rate": true
    }
  },
  {
    "component": {
      "id": 386937,
      "name": "Cancellation fee",
      "pricing_scheme": null,
      "unit_name": "on/off",
      "unit_price": "35.0",
      "product_family_id": 997233,
      "price_per_unit_in_cents": null,
      "kind": "on_off_component",
      "archived": false,
      "taxable": false,
      "description": "",
      "default_price_point_id": 108307,
      "price_point_count": 1,
      "price_points_url": "https://general-goods.chargify.com/components/386937/price_points",
      "tax_code": null,
      "recurring": true,
      "upgrade_charge": null,
      "downgrade_credit": null,
      "created_at": "2019-08-01T09:35:38-04:00",
      "default_price_point_name": "Original",
      "product_family_name": "Chargify",
      "use_site_exchange_rate": true
    }
  }
]