v1

latestOpenAPI 3.0.02026-08-06363576.8 KB
Subscription

Create multiple subscriptions

post/subscriptions/multi/

Request body

Example request

{
  "customer": {
    "first_name": "Jón",
    "last_name": "Jónsson",
    "email": "email@example.com",
    "phone": "+3545551234",
    "customer_reference": "1234"
  },
  "payment_method": {
    "token": "637302f0412e2e11adc0ba21adafcf11"
  },
  "subscriptions": [
    {
      "plan": 1,
      "reference": "Sub-12345",
      "start_date": "2022-11-01T00:00:00Z",
      "amount": "1500",
      "discount": "10",
      "description": "My custom note"
    }
  ]
}

Response

Response when creating multiple subscriptions for one customer

Example response

{
  "customer": {
    "first_name": "Jón",
    "last_name": "Jónsson",
    "email": "email@example.com",
    "phone": "+3545551234",
    "customer_reference": "1234",
    "id": 1,
    "payment_method": [
      {
        "verified": true,
        "valid_until": "2022-11-01T00:00:00Z",
        "display_info": "XXXX-XXXX-XXXX-2887 (MasterCard)"
      }
    ]
  },
  "subscriptions": [
    {
      "id": 123,
      "reference": "REF-12345",
      "token": "637302f0412e2e11adc0ba21adafcf11",
      "customer": 123,
      "plan": {
        "id": 1,
        "name": "Name of the plan.",
        "alternative_name": "A slightly longer name or more descriptive.",
        "reference": "SKU-1",
        "interval": "day|week|month|year",
        "interval_count": 1,
        "amount": "1.0000",
        "currency": "USD",
        "description": "A longer description.",
        "enabled": true,
        "electronic_only": true,
        "payment_processor": {
          "id": 1,
          "name": "Adyen processor",
          "type": "adyen"
        }
      },
      "billing_logs": [
        {
          "total": "6.99",
          "transaction": {
            "amount": "6.99",
            "currency": "USD"
          }
        }
      ]
    }
  ]
}