Lire la liste des abonnements

Lire la liste des abonnementsServer-sideAdmin

get/merchants/{merchant_id}/subscriptions

Répertorie tous les abonnements récurrents.

Remarque

Cette méthode API ne peut pas être utilisée en cas de charge élevée. La charge maximale est de 20 requêtes par minute.

Remarque

Cet appel API ne contient pas le paramètre de chemin project_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

ID de commerçant.

query Parameters

limit required	integer Nombre maximal d'éléments sur une page.
offset	integer Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).
user_id	string ID utilisateur.
project_id[]	Array of integers Liste des ID des projets.
plan_id[]	Array of integers Liste des ID des plans d'abonnement.
product_id[]	Array of integers Liste des ID des produits auxquels les plans sont liés.
group_id[]	Array of strings Liste des ID des groupes auxquels les plans sont liés.
status[]	Array of strings Statut. Items Enum: "active" "canceled" "non_renewing"
datetime_from	string <datetime> Date de l'échantillon. Permet de rechercher les abonnements créés après la requête.
datetime_to	string <datetime> Date de l'échantillon. Permet de rechercher les abonnements créés après la requête.

Responses

200

OK.

Request samples

Response samples

application/json

[{"charge_amount": 0.03,
"currency": "USD",
"date_create": "2013-09-05T15:27:47+0400",
"date_end": "2014-02006T11:32:48+0400",
"date_last_charge": null,
"date_next_charge": null,
"id": 45,
"plan": {"id": 12345,
"project_id": 12345
},
"product": {"id": null
},
"status": "canceled",
"user": {"id": "User1",
"name": "John Smith"
}
}
]