Skip to content

3.3 Products

Jump to bottom
Jedd Saliba edited this page Feb 14, 2024 · 11 revisions

Features

  • Create Product
  • Read Product
  • Update Product
  • Archive Product
  • Read Product by Handle
  • List Products

Create Product

Please see documentation here

URL

{{url}}/api/chargify/product

Form Data

{
    "name": "Gold Plan",
    "handle": "gold-plan",
    "description": "This is our gold plan.",
    "require_credit_card": true,
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "product_family_id": 2620123
}

Method

POST

Headers

{
    "Accept": "application/json"
}

Sample Response

{
    "status": true,
    "code": 201,
    "message": "Product created.",
    "result": {
        "id": 6627129,
        "name": "Gold Plan",
        "handle": "gold-plan",
        "description": "This is our gold plan.",
        "accounting_code": null,
        "request_credit_card": true,
        "expiration_interval": null,
        "expiration_interval_unit": null,
        "created_at": "2024-02-13T23:04:14-05:00",
        "updated_at": "2024-02-13T23:04:14-05:00",
        "price_in_cents": 1000,
        "interval": 1,
        "interval_unit": "month",
        "initial_charge_in_cents": null,
        "trial_price_in_cents": null,
        "trial_interval": null,
        "trial_interval_unit": null,
        "archived_at": null,
        "require_credit_card": true,
        "return_params": null,
        "taxable": false,
        "update_return_url": null,
        "tax_code": null,
        "initial_charge_after_trial": false,
        "version_number": 1,
        "update_return_params": null,
        "default_product_price_point_id": 2733108,
        "request_billing_address": false,
        "require_billing_address": false,
        "require_shipping_address": false,
        "use_site_exchange_rate": true,
        "item_category": null,
        "product_price_point_id": 2733108,
        "product_price_point_name": "Original",
        "product_price_point_handle": "uuid:09fd4150-ad1c-013c-4429-06fbf620b0fb",
        "product_family": {
            "id": 2620123,
            "name": "Sample Product Family",
            "description": "This is a sample product family description.",
            "handle": "sample-product-family",
            "accounting_code": null,
            "created_at": "2024-02-13T21:41:08-05:00",
            "updated_at": "2024-02-13T22:03:38-05:00"
        },
        "public_signup_pages": [
            {
                "id": 496362,
                "return_url": null,
                "return_params": null,
                "url": "https://your-domain.chargifypay.com/subscribe/sy93yrtzfmbx/gold-plan",
                "enabled": true,
                "nickname": null,
                "currency": "USD"
            }
        ]
    }
}

Read Product

Please see documentation here

URL

{{url}}/api/chargify/product/{{id}}

Method

GET

Headers

{
    "Accept": "application/json"
}

Sample Response

{
    "status": true,
    "code": 200,
    "message": "Product details.",
    "result": {
        "id": 6627130,
        "name": "Gold Plan",
        "handle": "gold-plan",
        "description": "This is our gold plan.",
        "accounting_code": null,
        "request_credit_card": true,
        "expiration_interval": null,
        "expiration_interval_unit": null,
        "created_at": "2024-02-13T23:40:04-05:00",
        "updated_at": "2024-02-13T23:40:04-05:00",
        "price_in_cents": 1000,
        "interval": 1,
        "interval_unit": "month",
        "initial_charge_in_cents": null,
        "trial_price_in_cents": null,
        "trial_interval": null,
        "trial_interval_unit": null,
        "archived_at": null,
        "require_credit_card": true,
        "return_params": null,
        "taxable": false,
        "update_return_url": null,
        "tax_code": null,
        "initial_charge_after_trial": false,
        "version_number": 1,
        "update_return_params": null,
        "default_product_price_point_id": 2733133,
        "request_billing_address": false,
        "require_billing_address": false,
        "require_shipping_address": false,
        "use_site_exchange_rate": true,
        "item_category": null,
        "product_price_point_id": 2733133,
        "product_price_point_name": "Original",
        "product_price_point_handle": "uuid:0b905a90-ad21-013c-969f-0284b5a8f85b",
        "product_family": {
            "id": 2620123,
            "name": "Sample Product Family",
            "description": "This is a sample product family description.",
            "handle": "sample-product-family",
            "accounting_code": null,
            "created_at": "2024-02-13T21:41:08-05:00",
            "updated_at": "2024-02-13T22:03:38-05:00"
        },
        "public_signup_pages": [
            {
                "id": 496364,
                "return_url": null,
                "return_params": null,
                "url": "https://your-domain.chargifypay.com/subscribe/54x8b6jn8xb4/gold-plan",
                "enabled": true,
                "nickname": null,
                "currency": "USD"
            }
        ]
    }
}

Update Product

Please see documentation here

URL

{{url}}/api/chargify/product/{{id}}

Form Data

{
    "name": "Gold Plan",
    "handle": "gold-plan",
    "description": "This is our gold plan.",
    "accounting_code": null,
    "require_credit_card": true,
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "product_family_id": 2620123
}

Method

PUT

Headers

{
    "Accept": "application/json"
}

Sample Response

{
    "status": true,
    "code": 200,
    "message": "Product updated.",
    "result": {
        "name": "Gold Plan",
        "handle": "gold-plan",
        "description": "This is our gold plan.",
        "accounting_code": null,
        "require_credit_card": true,
        "price_in_cents": 1000,
        "interval": 1,
        "interval_unit": "month",
        "tax_code": null,
        "id": 6627130,
        "request_credit_card": true,
        "expiration_interval": null,
        "expiration_interval_unit": null,
        "created_at": "2024-02-13T23:40:04-05:00",
        "updated_at": "2024-02-13T23:40:04-05:00",
        "initial_charge_in_cents": null,
        "trial_price_in_cents": null,
        "trial_interval": null,
        "trial_interval_unit": null,
        "archived_at": null,
        "return_params": null,
        "require_shipping_address": false,
        "request_billing_address": false,
        "require_billing_address": false,
        "taxable": false,
        "update_return_url": null,
        "initial_charge_after_trial": false,
        "default_product_price_point_id": 2733133,
        "item_category": null,
        "version_number": 1,
        "update_return_params": null,
        "product_price_point_id": 2733133,
        "product_price_point_name": "Original",
        "product_price_point_handle": "uuid:0b905a90-ad21-013c-969f-0284b5a8f85b",
        "use_site_exchange_rate": true,
        "product_family": {
            "id": 2620123,
            "name": "Sample Product Family",
            "description": "This is a sample product family description.",
            "handle": "sample-product-family",
            "accounting_code": null,
            "created_at": "2024-02-13T21:41:08-05:00",
            "updated_at": "2024-02-13T22:03:38-05:00"
        },
        "public_signup_pages": [
            {
                "id": 496364,
                "enabled": true,
                "nickname": null,
                "return_url": null,
                "return_params": null,
                "currency": "USD",
                "url": "https://your-domain.chargifypay.com/subscribe/54x8b6jn8xb4/gold-plan"
            }
        ]
    }
}

Archive Product

Please see documentation here

URL

{{url}}/api/chargify/product/{{id}}

Method

DELETE

Headers

{
    "Accept": "application/json"
}

Sample Response

{
    "status": true,
    "code": 200,
    "message": "Product archived.",
    "result": {
        "id": 6627130,
        "name": "Gold Plan",
        "handle": null,
        "description": "This is our gold plan.",
        "accounting_code": null,
        "request_credit_card": true,
        "expiration_interval": null,
        "expiration_interval_unit": null,
        "created_at": "2024-02-13T23:40:04-05:00",
        "updated_at": "2024-02-14T02:55:11-05:00",
        "price_in_cents": 1000,
        "interval": 1,
        "interval_unit": "month",
        "initial_charge_in_cents": null,
        "trial_price_in_cents": null,
        "trial_interval": null,
        "trial_interval_unit": null,
        "archived_at": "2024-02-14T02:55:11-05:00",
        "require_credit_card": true,
        "return_params": null,
        "require_shipping_address": false,
        "request_billing_address": false,
        "require_billing_address": false,
        "taxable": false,
        "update_return_url": null,
        "tax_code": null,
        "initial_charge_after_trial": false,
        "default_product_price_point_id": 2733133,
        "item_category": null,
        "version_number": 1,
        "update_return_params": null,
        "product_price_point_id": 2733133,
        "product_price_point_name": "Original",
        "product_price_point_handle": "uuid:0b905a90-ad21-013c-969f-0284b5a8f85b",
        "use_site_exchange_rate": true,
        "product_family": {
            "id": 2620123,
            "name": "Sample Product Family",
            "description": "This is a sample product family description.",
            "handle": "sample-product-family",
            "accounting_code": null,
            "created_at": "2024-02-13T21:41:08-05:00",
            "updated_at": "2024-02-13T22:03:38-05:00"
        },
        "public_signup_pages": [
            {
                "id": 496364,
                "enabled": true,
                "nickname": null,
                "return_url": null,
                "return_params": null,
                "currency": "USD",
                "url": "https://your-domain.chargifypay.com/subscribe/54x8b6jn8xb4"
            }
        ]
    }
}

Read Product by Handle

Please see documentation here

URL

{{url}}/api/chargify/product/handle{{handle}}

Method

GET

Headers

{
    "Accept": "application/json"
}

Sample Response

{
    "status": true,
    "code": 200,
    "message": "Product details by handle.",
    "result": {
        "id": 6627130,
        "name": "Gold Plan",
        "handle": "gold-plan",
        "description": "This is our gold plan.",
        "accounting_code": null,
        "request_credit_card": true,
        "expiration_interval": null,
        "expiration_interval_unit": null,
        "created_at": "2024-02-13T23:40:04-05:00",
        "updated_at": "2024-02-14T03:01:44-05:00",
        "price_in_cents": 1000,
        "interval": 1,
        "interval_unit": "month",
        "initial_charge_in_cents": null,
        "trial_price_in_cents": null,
        "trial_interval": null,
        "trial_interval_unit": null,
        "archived_at": null,
        "require_credit_card": true,
        "return_params": null,
        "require_shipping_address": false,
        "request_billing_address": false,
        "require_billing_address": false,
        "taxable": false,
        "update_return_url": null,
        "tax_code": null,
        "initial_charge_after_trial": false,
        "default_product_price_point_id": 2733133,
        "item_category": null,
        "version_number": 1,
        "update_return_params": null,
        "product_price_point_id": 2733133,
        "product_price_point_name": "Original",
        "product_price_point_handle": "uuid:0b905a90-ad21-013c-969f-0284b5a8f85b",
        "use_site_exchange_rate": true,
        "product_family": {
            "id": 2620123,
            "name": "Sample Product Family",
            "description": "This is a sample product family description.",
            "handle": "sample-product-family",
            "accounting_code": null,
            "created_at": "2024-02-13T21:41:08-05:00",
            "updated_at": "2024-02-13T22:03:38-05:00"
        },
        "public_signup_pages": [
            {
                "id": 496364,
                "enabled": true,
                "nickname": null,
                "return_url": null,
                "return_params": null,
                "currency": "USD",
                "url": "https://your-domain.chargifypay.com/subscribe/54x8b6jn8xb4/gold-plan"
            }
        ]
    }
}

List Products

Please see documentation here

URL

{{url}}/api/chargify/product

Parameters

{
    "page": 1,
    "per_page": 10,
}

Method

GET

Headers

{
    "Accept": "application/json"
}

Sample Response

{
    "status": true,
    "code": 200,
    "message": "Product list.",
    "result": [
        {
            "id": 6627130,
            "name": "Gold Plan",
            "handle": "gold-plan",
            "description": "This is our gold plan.",
            "accounting_code": null,
            "request_credit_card": true,
            "expiration_interval": null,
            "expiration_interval_unit": null,
            "created_at": "2024-02-13T23:40:04-05:00",
            "updated_at": "2024-02-14T03:01:44-05:00",
            "price_in_cents": 1000,
            "interval": 1,
            "interval_unit": "month",
            "initial_charge_in_cents": null,
            "trial_price_in_cents": null,
            "trial_interval": null,
            "trial_interval_unit": null,
            "archived_at": null,
            "require_credit_card": true,
            "return_params": null,
            "taxable": false,
            "update_return_url": null,
            "tax_code": null,
            "initial_charge_after_trial": false,
            "version_number": 1,
            "update_return_params": null,
            "default_product_price_point_id": 2733133,
            "request_billing_address": false,
            "require_billing_address": false,
            "require_shipping_address": false,
            "use_site_exchange_rate": true,
            "item_category": null,
            "product_price_point_id": 2733133,
            "product_price_point_name": "Original",
            "product_price_point_handle": "uuid:0b905a90-ad21-013c-969f-0284b5a8f85b",
            "product_family": {
                "id": 2620123,
                "name": "Sample Product Family",
                "description": "This is a sample product family description.",
                "handle": "sample-product-family",
                "accounting_code": null,
                "created_at": "2024-02-13T21:41:08-05:00",
                "updated_at": "2024-02-13T22:03:38-05:00"
            },
            "public_signup_pages": [
                {
                    "id": 496364,
                    "return_url": null,
                    "return_params": null,
                    "url": "https://your-domain.chargifypay.com/subscribe/54x8b6jn8xb4/gold-plan",
                    "enabled": true,
                    "nickname": null,
                    "currency": "USD"
                }
            ]
        }
    ]
}

Clone this wiki locally