Créer un abonnement avec l'API Recharge

Crée un abonnement sur une adresse d'un client et le renvoie. Le produit doit avoir au moins un plan dans Recharge. Les champs de fréquence, la date du premier prélèvement, la variante, la quantité et l'adresse sont obligatoires.

Identifiant
recharge_create_subscription

L'appel

POST https://connect.reportei.com/api/tools/recharge_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "address_id": 1,
    "external_variant_id": {},
    "quantity": 1,
    "next_charge_scheduled_at": "<next_charge_scheduled_at>",
    "order_interval_unit": "day",
    "order_interval_frequency": 1,
    "charge_interval_frequency": 1
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
address_idintegerOuiId of an address of the customer, from the addresses of Get customer with include addresses, or the address_id of a subscription in List subscriptions.
external_variant_idobjectOuiProduct variant in the store platform. The variant id comes from external_variant_id of a subscription in List subscriptions, or from the product page in the store admin.
quantityintegerOuiNumber of units in each order.
next_charge_scheduled_atstringOuiDate of the first charge, as YYYY-MM-DD.
order_interval_unitstringOuiUnit of the order and charge frequencies.Valeurs : day, week, month
order_interval_frequencyintegerOuiNumber of order_interval_unit between orders, such as 1 for a monthly order.
charge_interval_frequencyintegerOuiNumber of order_interval_unit between charges. Equal to order_interval_frequency when each order is paid on its own; a multiple of it for a prepaid subscription.
order_day_of_monthintegerNonDay of the month the orders are created on, when order_interval_unit is month.
order_day_of_weekintegerNonDay of the week the orders are created on, when order_interval_unit is week.
expire_after_specific_number_of_chargesintegerNonNumber of charges after which the subscription expires. Without it, the subscription runs until it is cancelled.
pricestringNonPrice of one unit, such as 10.00.
product_titlestringNonName of the product.
propertiesarrayNonLine item properties of the subscription, such as a color or an engraving text.

Connexions possibles

Votre client connecte son compte Recharge une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/recharge_create_subscription. Il devient la définition de tool de votre agent sans conversion.

Autres tools Recharge

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.