Abonnements abrufen

Xsolla Developers

oder

Abonnements abrufenServer-sideAdmin

get/merchants/{merchant_id}/subscriptions

Listet alle wiederkehrenden Abonnements auf.

Bemerkung

Diese API-Methode kann bei hoher Belastung nicht verwendet werden. Die maximale Belastung beträgt 20 Anfragen pro Minute.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, daher müssen Sie zum Einrichten der Autorisierung den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

Händler-ID.

query Parameters

limit required	integer Begrenzung der Elementanzahl auf der Seite.
offset	integer Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).
user_id	string Benutzer-ID.
project_id[]	Array of integers Liste der Projekt-IDs.
plan_id[]	Array of integers Liste der Abo-Modell-IDs.
product_id[]	Array of integers Liste der Produkt-IDs, mit denen die Abo-Modelle verknüpft sind.
group_id[]	Array of strings Liste der Gruppen-IDs, mit denen die Abo-Modelle verknüpft sind.
status[]	Array of strings Status. Items Enum: "active" "canceled" "non_renewing"
datetime_from	string <datetime> Abfragedatum. Damit findet man Abonnements, die nach dem angegebenen Datum erstellt wurden.
datetime_to	string <datetime> Abfragedatum. Damit findet man Abonnements, die nach dem angegebenen Datum erstellt wurden.

Responses

200

OK.

Request samples

curl -i -X GET \
  -u <merchant_id>:<api_key> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions?limit=0&offset=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'

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"
}
}
]