专家用法

介绍

以下是您可能需要处理或继续阅读的一些其他有用主题,在此作为参考。这些通常是可能对Chargify的专家用法有用的主题。

高级注册示例

以下是您可能会遇到的有关新注册/订阅的一些高级/专家示例。这些可能很常见,但完全取决于您使用Chargify的哪些功能以及如何集成对Chargify的使用。

  1. 导入为新的注册/订阅

例子

// POST /subscriptions.json
{
    "subscription": {
        "product_handle": "basic",
        "next_billing_at": "2010-08-29T12:00:00-04:00",
        "customer_attributes": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "reference": "123",
            "organization": "Acme Widgets"
        },
        "payment_profile_attributes": {
            "vault_token": "12345",
            "customer_vault_token": "67890",
            "current_vault": "authorizenet",
            "expiration_year": "2020",
            "expiration_month": "12",
            "card_type": "visa",
            "last_four": "1111"
        }
    }
}

有关此方法的完整详细信息,请参见 API订阅导入

  1. 带有优惠券/试用版/组件的新订阅

注册可以从最初创建订阅起就实现优惠券,自定义试用期和组件,如下所示:

例子

{
    "subscription": {
        "product_handle": "basic",
      	"customer_attributes": {
      	    "first_name": "John",
      		"last_name": "Smith",
      		"email": "john@example.com"
      	},
      	"credit_card_attributes": {
      		"full_number": "1",
      		"expiration_month": "10",
      		"expiration_year": "2020"
      	},
      	"coupon_code": "SUB111",
        "next_billing_at": "2020-06-01",
        "components": [{
    		"component_id": 123456,
    		"unit_balance": 20
    	}]
    }
}

有关订阅创建的完整详细信息,请参阅 创建订阅.

  1. 具有现有付款资料的新订阅

元字段/元数据

您可能会发现您需要在Chargify的客户或订阅对象中存储更多信息,以更好地与您的集成保持一致。在这种情况下,您可以添加/使用元字段来存储此元数据。

例子

首先,您将创建您的元字段。在此示例中,我们将为客户添加一个颜色字段:

// POST /customers/metafields.json
{ 
    "metafields": {
        "name": "Color",
        "scope": {"hosted": ["all"], "csv": "1", "invoices": "1", "statements": "1"}
    }
}

The options for scope here would show this metafield on all public/hosted pages, show the metadata on invoices and subscriptions and allow the metadata to be exported via CSV.

第二,然后为特定的用户设置颜色:

// POST /customers/{customer_id}/metadata.json
{ 
    "metadata": {
        "name": "Color",
        "value": "Blue"
    } 
}

然后,特定客户会将元字段“颜色”的元数据设置为“蓝色”。

有关“元字段”(元数据的容器)的更多API信息,请参见 自定义字段:元字段.

沟通

Chargify使您可以通过多种方法与订户进行通信:

催款

催款是您与客户进行交易的过程,涉及信用卡交易失败和信用卡过期。

Chargify帮助管理催款过程,或者我们称之为“不愉快之路”的事情。或信用卡交易失败时会发生什么。如果您使用的是Authorize.net,PayPal或Google Checkout,则必须手动解决每次出现的信用卡问题。这既繁琐又费时,并且在执行大量事务时肯定不是处理问题的最有效方法。

有关催款的更多信息-包括如何设置催款计划,请参阅 催款 .

推荐人

推荐是奖励客户与新的潜在用户共享有关您的应用程序信息的好方法。当使用该代码创建新注册时,Chargify会为您的每个订阅生成一个引荐代码,并奖励新客户和引荐来源。

If referrals are enabled, then every subscription will have a ref (short for “referral code”) as part of the available data in the subscription API response.

例子

// GET /subscriptions/{subscription_id}.{format}
{
    "subscription": {
        "id": "123456789",
        "state": "active",
        // ...
        "ref": "trdgzp"
    }
}

要验证代码,您可以执行以下操作:

HTTP GET: //{subdomain}.ikvrej.icu/referral_codes/validate.{format}?code={ref/referral_code}

If the referral code is valid, the response will be 200 OK. Otherwise, the response will be 404 NOT FOUND.

有关推荐的更多信息,请参见 推荐人 .

笔记

您还可以输入和管理订阅的注释。注释允许您保留与单个订阅关联的非结构化数据。如果您需要结构化数据,请考虑使用 元字段/元数据.

要在订阅上创建简单的注释,请参见以下内容:

// POST /subscriptions/{subscription_id}/notes.{format}
{
    "note": {
        "body": "This is the note that never ends, it just goes on and on ..",
        "sticky": true
  }
}

Setting the value for sticky to true will show the note prominently when viewing the subscription.

有关笔记的完整API信息,请参阅 API注释 .