Create a New Subscription

post https://api.annanow-pay.com/v1.0/Subscription/

🚧
Experimental documentation state
This functionality is already in productional use, but the documentation might contain some errors. Please contact us if you are interested in handling Subscriptions through your own application.

Query Params

instance

string

required

Your Annanow instance name

Form Data

userId

string

required

The contact id you got from webhook.

psp

string

required

The ID of the psp to use.

amount

string

required

The amount of the payment to fire in cents.

currency

string

required

The ISO code of the currency of the payment.

purpose

string

required

The payment purpose. What is the payer paying for?

paymentInterval

string

required

The payment interval as string. (see PHP documentation of date interval for format)

period

string

required

The subscription's period as string. (see PHP documentation of date interval for format)

cancellationInterval

string

required

The interval of cancellation as string. (see PHP documentation of date interval for format)

referenceId

string

The internal reference id. (Will be sent back with Webhook, can be used as identification)

Response

Language

Request


xxxxxxxxxx
26
1
<?php
2
// $instanceName is a part of the url where you access your annanow installation.
3
// https://{$instanceName}.annanow-pay.com
4
$instanceName = 'YOUR_INSTANCE_NAME';
5
6
// $secret is the annanow secret for the communication between the applications
7
// if you think someone got your secret, just regenerate it in the annanow administration
8
$secret = 'YOUR_SECRET';
9
10
$annanow = new \Annanow\Annanow($instanceName, $secret);
11
12
$subscription = new \Annanow\Models\Request\Subscription();
13
$subscription->setUserId(1);
14
$subscription->setPsp(4);
15
$subscription->setPurpose('Test');
16
$subscription->setAmount(100);
17
$subscription->setCurrency('CHF');
18
$subscription->setPaymentInterval('P1M');
19
$subscription->setPeriod('P1Y');
20
$subscription->setCancellationInterval('P1M');
21
try {
22
    $response = $annanow->create($subscription);
23
    var_dump($response);
24
} catch (\Annanow\AnnanowxException $e) {
25
    print $e->getMessage();
26
}

Choose an example:

application/json

🚧Experimental documentation state

200200

🚧
Experimental documentation state