Fungies home page

Dashboard
Dashboard

SUBSCRIPTIONS

Get subscription by id

API Documentation

Introduction

DISCOUNTS

GET
Search discounts
POST
Create a new discount
GET
Get discount by ID
PATCH
Update a discount
PATCH
Archive a discount

OFFERS

GET
Search offers
POST
Create a new offer
PATCH
Update an offer
PATCH
Archive an offer
POST
Add product keys
DEL
Remove unsold keys
DEL
Remove unsold key

ORDERS

GET
List orders
GET
Get order details
PATCH
Update order
PATCH
Cancel order

PRODUCTS

GET
Search products
POST
Create a new product
GET
Get product by ID
PATCH
Archive a product
PATCH
Update a product
POST
Duplicate a product
POST
Add a variant to a product
PATCH
Update a variant
PATCH
Archive a variant

SUBSCRIPTIONS

GET
List subscriptions
GET
Get subscription by id
PATCH
Cancel subscription

USERS

GET
List users
POST
Create a new user
GET
Get user details
PATCH
Update user
PATCH
Archive user
GET
Get user's inventory

SUBSCRIPTIONS

Get subscription by id

Retrieve a subscription by its id

GET

subscriptions

{subscriptionId}

Public-Key

string

Public-Key

Required

string

subscriptionId

string

subscriptionId

Required

string

GET /v1/subscriptions/:subscriptionId Parameter

Authorizations

Public-Key

string

headerrequired

Path Parameters

subscriptionId

string

required

GET /v1/subscriptions/:subscriptionId Parameter

Response

200 - application/json

status

string

required

Allowed value: "success"

data

object

required

data.id

string

required

data.currentPeriodEnd

integer

required

Required range: 0 < x < 9007199254740991

data.currentPeriodStart

integer

required

Required range: 0 < x < 9007199254740991

data.cancelAtPeriodEnd

boolean

required

data.createdAt

integer

required

Required range: 0 < x < 9007199254740991

data.status

enum<string>

required

Available options:

active,

canceled,

incomplete,

incomplete_expired,

past_due,

paused,

trialing,

unpaid

data.interval

enum<string>

required

Available options:

day,

week,

month,

year

data.canceledAt

integer

Required range: 0 < x < 9007199254740991

data.cancellationDetails

object

data.cancellationDetails.comment

string

data.cancellationDetails.feedback

string

data.cancellationDetails.reason

string

data.user

object

data.user.id

string

required

data.user.details

object

required

data.user.details.avatar

string

data.user.settings

object

required

data.user.settings.newsletter

boolean

data.user.email

string | null

data.user.createdAt

integer

Required range: 0 < x < 9007199254740991

data.user.username

string | null

data.cart

object

data.cart.id

string

required

data.cart.itemsInCart

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.cart.totalValue

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.cart.subtotal

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.cart.totalValueWithTax

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.cart.totalTax

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.cart.status

enum<string>

Available options:

ACTIVE,

ABANDONED,

PENDING_SUBSCRIPTION,

COMPLETED

data.cart.createdAt

integer

Required range: 0 < x < 9007199254740991

List subscriptions Cancel subscription

twitter linkedin discord facebook website