Subscribing customers

You can subscribe a customer to a rate card in the dashboard or using the API (either directly or via a checkout flow).

Prerequisite: Creating subjects

Every customer you want to subscribe to a rate card should be represented by a subject. You should create these subjects every time a new customer signs up for your service.

SDK

subject = lark_client.subjects.create(
    external_id="customer_id_from_your_system",
    name="John Doe",
    email="john.doe@example.com",
)

Dashboard

1. Go to the subjects page and click “New Subject”.
2. Fill in the form with the following values:
   • Name: John Doe
   • Email: john.doe@example.com
   • (Optional) External ID: customer_id_from_your_system
3. Click “Save”.

Creating subscriptions

You can create a subscription for a subject to a rate card using the API or the dashboard. The response will either be a subscription object or a checkout URL.

• If the subject does not have a payment method on file, the response will provide a checkout URL to redirect the customer to.
• If the subject has a payment method on file, the subscription will be created immediately unless create_checkout_session='always' is specified in the request.

SDK

subscription = lark_client.subscriptions.create(
    subject_id="customer_id_from_your_system",
    rate_card_id="RATE_CARD_ID",
    checkout_callback_urls={
        "success_url": "https://example.com/success",
        "cancelled_url": "https://example.com/cancelled",
    },
)

Dashboard

1. Go to the subjects page and click on the subject you want to subscribe to a rate card.
2. Click on the “Subscriptions” tab.
3. Click “New Subscription”.
4. Select the rate card you want to subscribe to from the dropdown.
5. Click “Save”.

You can use the following test cards to complete the checkout process in a sandbox account:

• Visa: 4242 4242 4242 4242
• Mastercard: 5555 5555 5555 4444
• American Express: 3782 822463 10005
• Discover: 6011 1111 1111 1117
• Diners Club: 3056 930902 5904
• JCB: 3530 1113 3330 0000
• UnionPay: 6200 0000 0000 0000

If you are using Adyen, you can find test cards here.

Fetching subscriptions

If you query subscriptions for the subject, you should now see a subscription with status active.

SDK

subscriptions = lark_client.subscriptions.list(
    subject_id="customer_id_from_your_system"
)

subscription = subscriptions.subscriptions[0]

Dashboard

1. Go to the subscriptions page.
2. Filter by subject ID: customer_id_from_your_system.
3. You should see a subscription with status active.

Managing subscriptions

You can redirect customers to the hosted customer portal to manage their subscriptions.

customer_portal_session = lark_client.customer_portal.create_session(
    subject_id="customer_id_from_your_system",
    return_url="https://example.com/return",
)

You should then redirect the customer to the customer_portal_session.url.

You can also cancel a subscription using the API or the dashboard.