web - tier subscription

Developing

Develop Env

https://test-api.talkamie.com/v1

POST

/web/finance/subscription/session

this initiates a subscription request for a user;
it returns an external link and a transaction ID; the external link is used to make the payment on a third-party platform;

when an error occurs, such as a network failure, and the user makes the same intent to subscribe, the transaction ID should be sent along, to avoid transaction duplicates;

Request

Header Params

Authorization

string

required

Example:

Bearer <token>

Body Params application/json

tier

enum<integer>

required

Allowed values:

periodicRate

enum<string>

required

Allowed values:

monthlyyearly

transactionId

string

optional

initially, a transaction ID is returned in the response; if the same request is to be sent again, the transaction ID should be sent with it to ensure idempotency while retrying with the same request, and to avoid duplicate transactions;

recurring

boolean

optional

Example

{
    "tier": 1,
    "periodicRate": "monthly",
    "transactionId": "string",
    "recurring": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test-api.talkamie.com/v1/web/finance/subscription/session' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tier": 1,
    "periodicRate": "monthly",
    "transactionId": "string",
    "recurring": true
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "data": {
        "session": {
            "id": "string",
            "url": "https://some/url"
        },
        "transaction": {
            "id": "string"
        }
    }
}

Modified at 2025-07-30 06:00:05

subscriptions

web - cancel subscription