API.getSubscriptionInfos
This action allows you to recover the information about a subscription.
Request
The API key must have the commons access right.
| Name | Type | Description |
|---|---|---|
| apikey[required] | string | API public key |
| signature[required] | string | Signature of the request. See how to sign your requests. |
| expires | timestamp | UNIX timestamp for request expiration. |
| output | string | Format of the response. Either XML (default), JSON or PHP. |
| subscription_id[required] | integer | ID of the subscirption. |
Response
Returns a subscription.
Example responses
<response>
<requestid>...</requestid>
<requests>...</requests>
<status>ok</status>
<content>
<ID>...</ID>
<AccountID>...</AccountID>
<Name>...</Name>
<Description>...</Description>
<Books>...</Books>
<Subscribers>...</Subscribers>
<Creation>...</Creation>
<Modification>...</Modification>
<PublicUrl>...</PublicUrl>
</content>
</response>
{
"response": {
"requestid": ...,
"requests": ...,
"status": "ok",
"content": {
"ID": ...,
"AccountID": ...,
"Name": ...,
"Description": ...,
"Books": ...,
"Subscribers": ...,
"Creation": ...,
"Modification": ...,
"PublicUrl": ...
}
}
}
[
"response" => [
"requestid" => ...,
"requests" => ...,
"status" => "ok",
"content" => [
"ID" => ...,
"AccountID" => ...,
"Name" => ...,
"Description" => ...,
"Books" => ...,
"Subscribers" => ...,
"Creation" => ...,
"Modification" => ...,
"PublicUrl" => ...
]
]
]
Error codes
See the error code section.
