Create Subscription

curl --request POST \
  --url https://api.fungies.io/v0/subscriptions/create \
  --header 'Content-Type: application/json' \
  --header 'x-fngs-public-key: <api-key>' \
  --header 'x-fngs-secret-key: <api-key>' \
  --data '
{
  "items": [
    {
      "name": "<string>",
      "unitPrice": 123,
      "currency": "AFN",
      "quantity": 1,
      "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "price": 8.988465674311579e+307,
      "value": 8.988465674311579e+307
    }
  ],
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userEmail": "[email protected]",
  "backdateStartDate": 4503599627370495,
  "billingCycleAnchor": 4503599627370495,
  "trialEnd": 4503599627370495,
  "skipTrial": false,
  "skipNotifications": false
}
'

{
  "status": "<string>",
  "data": {
    "subscription": {
      "id": "<string>",
      "status": "all",
      "createdAt": 4503599627370495,
      "currentIntervalEnd": 4503599627370495,
      "currentIntervalStart": 4503599627370495,
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderNumber": "<string>",
      "order": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "status": "PENDING",
        "object": "order"
      },
      "object": "subscription",
      "cancelAtIntervalEnd": false,
      "canceledAt": null,
      "userId": null,
      "user": null,
      "lastPaymentId": null,
      "lastPaymentNumber": null,
      "lastPayment": null
    }
  }
}

POST

subscriptions

create

Create Subscription

curl --request POST \
  --url https://api.fungies.io/v0/subscriptions/create \
  --header 'Content-Type: application/json' \
  --header 'x-fngs-public-key: <api-key>' \
  --header 'x-fngs-secret-key: <api-key>' \
  --data '
{
  "items": [
    {
      "name": "<string>",
      "unitPrice": 123,
      "currency": "AFN",
      "quantity": 1,
      "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "price": 8.988465674311579e+307,
      "value": 8.988465674311579e+307
    }
  ],
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userEmail": "[email protected]",
  "backdateStartDate": 4503599627370495,
  "billingCycleAnchor": 4503599627370495,
  "trialEnd": 4503599627370495,
  "skipTrial": false,
  "skipNotifications": false
}
'

{
  "status": "<string>",
  "data": {
    "subscription": {
      "id": "<string>",
      "status": "all",
      "createdAt": 4503599627370495,
      "currentIntervalEnd": 4503599627370495,
      "currentIntervalStart": 4503599627370495,
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderNumber": "<string>",
      "order": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "status": "PENDING",
        "object": "order"
      },
      "object": "subscription",
      "cancelAtIntervalEnd": false,
      "canceledAt": null,
      "userId": null,
      "user": null,
      "lastPaymentId": null,
      "lastPaymentNumber": null,
      "lastPayment": null
    }
  }
}

Authorizations

x-fngs-public-key

string

header

required

x-fngs-secret-key

string

header

required

Body

application/json

POST /v0/subscriptions/create Request body

items

object[]

required

Required array length: 1 element

Show child attributes

items.name

string

Name of the Item. Required if Offer ID is not provided. Can be used to override the Offer name.

items.unitPrice

integer<int64>

New unit price in cents (min: 100). Required if Offer ID is not provided. Can be used to override the Offer price.

Required range: x <= 9007199254740991

items.currency

enum<string>

Valid currency code. Required if value is provided. Required if Offer ID is not provided. Can be used to override the Offer currency.

Note: Currently needs to match Workspace currency.

Available options:

AFN,

ALL,

DZD,

AOA,

ARS,

AMD,

AWG,

AUD,

AZN,

BSD,

BDT,

BBD,

BZD,

BMD,

BOB,

BAM,

BWP,

BRL,

BHD,

GBP,

BND,

BGN,

BIF,

BYN,

KHR,

CAD,

CVE,

KYD,

KWD,

XAF,

XPF,

CLP,

CNY,

COP,

KMF,

CDF,

CRC,

HRK,

CZK,

DKK,

DJF,

DOP,

XCD,

EGP,

ETB,

EUR,

FKP,

FJD,

GMD,

GEL,

GIP,

GTQ,

GNF,

GYD,

HTG,

HNL,

HKD,

HUF,

ISK,

INR,

IDR,

ILS,

JMD,

JPY,

JOD,

KZT,

KES,

KGS,

LAK,

LBP,

LSL,

LRD,

MOP,

MKD,

MGA,

MWK,

MYR,

MVR,

MRO,

MUR,

MXN,

MDL,

MNT,

MAD,

MZN,

MMK,

NAD,

NPR,

ANG,

TWD,

NZD,

NIO,

NGN,

NOK,

OMR,

PKR,

PAB,

PGK,

PYG,

PEN,

PHP,

PLN,

QAR,

RON,

RUB,

RWF,

SHP,

SVC,

WST,

STD,

SAR,

RSD,

SCR,

SLL,

SGD,

SBD,

SOS,

ZAR,

KRW,

LKR,

SRD,

SZL,

SEK,

CHF,

TJS,

TZS,

THB,

TND,

TOP,

TTD,

TRY,

UGX,

UAH,

AED,

UYU,

USD,

UZS,

VUV,

VEF,

VND,

XOF,

YER,

ZMW,

SLE,

XCG,

SSP,

VES,

MRU,

STN,

VED

items.quantity

number<double>

default:1

Optional quantity (default: 1).

Required range: 1 <= x <= 1.7976931348623157e+308

items.offerId

string<uuid>

Optional valid Offer ID. Adds Offer reference to the Item.

Note: name, value and currency are derived from the Offer if not provided.
  - name: Offer name with full specification
  - value: Offer price
  - currency: Offer currency

items.price

number<double>

Deprecated. Use value instead.

Required range: 100 <= x <= 1.7976931348623157e+308

items.value

number<double>

Deprecated. Use unitPrice instead.

Required range: 100 <= x <= 1.7976931348623157e+308

userId

string<uuid>

userEmail

string<email>

backdateStartDate

integer<int64> | null

Required range: 0 <= x <= 9007199254740991

billingCycleAnchor

integer<int64> | null

Required range: 0 <= x <= 9007199254740991

trialEnd

integer<int64> | null

Required range: 0 <= x <= 9007199254740991

skipTrial

boolean

default:false

skipNotifications

boolean

default:false

Response

POST /v0/subscriptions/create Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

data.subscription

object

required

Show child attributes

data.subscription.id

string

required

data.subscription.status

enum<string>

required

Available options:

all,

active,

canceled,

incomplete,

incomplete_expired,

past_due,

trialing,

paused,

unpaid

data.subscription.createdAt

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.subscription.currentIntervalEnd

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.subscription.currentIntervalStart

integer<int64> | null

required

Required range: 0 <= x <= 9007199254740991

data.subscription.orderId

string<uuid>

required

data.subscription.orderNumber

string

required

data.subscription.order

object

required

Show child attributes

data.subscription.order.id

string<uuid>

required

data.subscription.order.number

string

required

data.subscription.order.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.subscription.order.object

enum<string>

default:order

Available options:

order

data.subscription.object

enum<string>

default:subscription

Available options:

subscription

data.subscription.cancelAtIntervalEnd

boolean

default:false

data.subscription.canceledAt

integer<int64> | null

Required range: 0 <= x <= 9007199254740991

data.subscription.userId

string<uuid> | null

data.subscription.user

object

Show child attributes

data.subscription.user.id

string<uuid>

required

data.subscription.user.object

enum<string>

default:user

Available options:

user

data.subscription.user.username

string | null

data.subscription.lastPaymentId

string<uuid> | null

data.subscription.lastPaymentNumber

string | null

data.subscription.lastPayment

object

Show child attributes

data.subscription.lastPayment.id

string<uuid>

required

data.subscription.lastPayment.type

enum<string>

required

Available options:

one_time,

subscription_initial,

subscription_update,

subscription_interval,

subscription_extra,

claim_free

data.subscription.lastPayment.number

string

required

data.subscription.lastPayment.status

enum<string>

required

Available options:

PENDING,

PAID,

FAILED,

UNPAID,

CANCELLED,

REFUNDED,

PARTIALLY_REFUNDED,

EXPIRED

data.subscription.lastPayment.object

enum<string>

default:payment

Available options:

payment

List Subscriptions Get Subscription

⌘I

API v0 Documentation

discounts

offers

orders

payments

products

subscriptions

users

elements

Create Subscription

Authorizations

Body

Response