Class default

Index

Constructors

Methods

cancelCommunityInfluencerSubscription cancelCreatorSubscription cancelGift changeCommunityInfluencerSubscription createCommunityInfluencerSubscription createCreatorSubscription createCustomCommunitySubscription getCommunityInfluencerSubscription getCreatorSubscription listCommunityInfluencerSubscriptions listCreatorSubscriptions listMyLicenses purchaseGift purchaseLicense redeemGift refundLicense validateCoupon

Constructors

constructor

new default(): default
Returns default

Methods

`Static` cancelCommunityInfluencerSubscription

cancelCommunityInfluencerSubscription<T>(community_id, stripe_subscription_id, data?, params?): AxiosPromise<default<T>>
Cancels a community subscription
Type Parameters
- T
Parameters
- community_id: string
- stripe_subscription_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/cancelCommunityInfluencerSubscription
- Defined in api/Subscriptions.ts:92

`Static` cancelCreatorSubscription

cancelCreatorSubscription<T>(stripe_subscription_id, data?, params?): AxiosPromise<default<T>>
Cancels a creator subscription
Type Parameters
- T
Parameters
- stripe_subscription_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/cancelCreatorSubscription
- Defined in api/Subscriptions.ts:81

`Static` cancelGift

cancelGift<T>(gift_id): AxiosPromise<default<T>>
Cancel an unredeemed gift and trigger a refund. Only the user who purchased the gift (the giver) can perform this action.
Type Parameters
- T
Parameters
- gift_id: string
  The UUID of the gift to cancel.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/cancelGift
- Defined in api/Subscriptions.ts:174

`Static` changeCommunityInfluencerSubscription

changeCommunityInfluencerSubscription<T>(community_id, data?, params?): AxiosPromise<default<T>>
Change the current subscription that the community is associated with.
Type Parameters
- T
Parameters
- community_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/createCreatorSubscription
- Defined in api/Subscriptions.ts:103

`Static` createCommunityInfluencerSubscription

createCommunityInfluencerSubscription<T>(community_id, data?, params?): AxiosPromise<default<T>>
Create a new subscription of a community engaging in influencer marketing
Type Parameters
- T
Parameters
- community_id: string
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/createCommunityInfluencerSubscription
- Defined in api/Subscriptions.ts:70

`Static` createCreatorSubscription

createCreatorSubscription<T>(data?, params?): AxiosPromise<default<T>>
Create a new subscription of a content creator
Type Parameters
- T
Parameters
- Optional data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/createCreatorSubscription
- Defined in api/Subscriptions.ts:59

`Static` createCustomCommunitySubscription

createCustomCommunitySubscription<T>(community_id, data, params?): AxiosPromise<default<T>>
Create a custom tailored subscription for a business/community. Only accessible by Glitch administrators.
Type Parameters
- T
Parameters
- community_id: string
  The ID of the community.
- data: object
  { priceId, paymentMethod, custom_name, limits: { posts, enrichments, invites, ads }, metered_prices: [] }
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Subscriptions.ts:114

`Static` getCommunityInfluencerSubscription

getCommunityInfluencerSubscription<T>(community_id, stripe_subscription_id, params?): AxiosPromise<default<T>>
Get a s subscription plan that a community has to talk with influencers
Type Parameters
- T
Parameters
- community_id: string
- stripe_subscription_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/getCommunityInfluencerSubscription
- Defined in api/Subscriptions.ts:26

`Static` getCreatorSubscription

getCreatorSubscription<T>(stripe_subscription_id, params?): AxiosPromise<default<T>>
Get a creator subscription for the creator program.
Type Parameters
- T
Parameters
- stripe_subscription_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/getCreatorSubscription
- Defined in api/Subscriptions.ts:15

`Static` listCommunityInfluencerSubscriptions

listCommunityInfluencerSubscriptions<T>(community_id, params?): AxiosPromise<default<T>>
List all the subscription plans that a community has.
Type Parameters
- T
Parameters
- community_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/getCommunityInfluencerSubscriptions
- Defined in api/Subscriptions.ts:48

`Static` listCreatorSubscriptions

listCreatorSubscriptions<T>(params?): AxiosPromise<default<T>>
List all the subscription plans that a creator has.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/getCreatorSubscriptions
- Defined in api/Subscriptions.ts:37

`Static` listMyLicenses

listMyLicenses<T>(params?): AxiosPromise<default<T>>
List all game licenses (Premium/Rental) owned by the current user.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Subscriptions.ts:130

`Static` purchaseGift

purchaseGift<T>(data): AxiosPromise<default<T>>
Purchase a game or subscription as a gift for another user.
Type Parameters
- T
Parameters
- data: object
  { gift_type: 'premium'|'rental'|'subscription', payment_method_id: string, title_id?: string, recipient_id?: string, recipient_email?: string, recipient_name?: string }
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/purchaseGift
- Defined in api/Subscriptions.ts:149

`Static` purchaseLicense

purchaseLicense<T>(title_id, data): AxiosPromise<default<T>>
Purchase a permanent license or rent a game title. If a rental was active in the last 7 days, the fee is automatically deducted from the premium price.
Type Parameters
- T
Parameters
- title_id: string
- data: object
  { purchase_type: 'premium' | 'rental', payment_method_id: string }
Returns AxiosPromise<default<T>>
- Defined in api/Subscriptions.ts:123

`Static` redeemGift

redeemGift<T>(redemption_code): AxiosPromise<default<T>>
Redeem a gift code to grant access to a game or subscription.
Type Parameters
- T
Parameters
- redemption_code: string
  The unique GLITCH-XXXX-XXXX code.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Subscriptions/redeemGift
- Defined in api/Subscriptions.ts:161

`Static` refundLicense

refundLicense<T>(license_id): AxiosPromise<default<T>>
Request a refund for a premium purchase.
Type Parameters
- T
Parameters
- license_id: string
Returns AxiosPromise<default<T>>
- Defined in api/Subscriptions.ts:137

`Static` validateCoupon

validateCoupon<T>(data): AxiosPromise<default<T>>
Validates a coupon code and returns the calculated discount.
Type Parameters
- T
Parameters
- data: {
      code: string;
      currency?: string;
      price: number;
  }
  { code: string, price: number, currency?: string }
  - code: string
  - Optional currency?: string
  - price: number
Returns AxiosPromise<default<T>>
- Defined in api/Subscriptions.ts:182

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static cancelCommunityInfluencerSubscription

Type Parameters

T

Parameters

community_id: string

stripe_subscription_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static cancelCreatorSubscription

Type Parameters

T

Parameters

stripe_subscription_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static cancelGift

Type Parameters

T

Parameters

gift_id: string

Returns AxiosPromise<default<T>>

See

Static changeCommunityInfluencerSubscription

Type Parameters

T

Parameters

community_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static createCommunityInfluencerSubscription

Type Parameters

T

Parameters

community_id: string

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static createCreatorSubscription

Type Parameters

T

Parameters

Optional data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static createCustomCommunitySubscription

Type Parameters

T

Parameters

community_id: string

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static getCommunityInfluencerSubscription

Type Parameters

T

Parameters

community_id: string

stripe_subscription_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static getCreatorSubscription

Type Parameters

T

`Static` cancelCommunityInfluencerSubscription

`Optional` data: object

`Optional` params: Record<string, any>

`Static` cancelCreatorSubscription

`Optional` data: object

`Optional` params: Record<string, any>

`Static` cancelGift

`Static` changeCommunityInfluencerSubscription

`Optional` data: object

`Optional` params: Record<string, any>

`Static` createCommunityInfluencerSubscription

`Optional` data: object

`Optional` params: Record<string, any>

`Static` createCreatorSubscription

`Optional` data: object

`Optional` params: Record<string, any>

`Static` createCustomCommunitySubscription

`Optional` params: Record<string, any>

`Static` getCommunityInfluencerSubscription

`Optional` params: Record<string, any>

`Static` getCreatorSubscription

`Optional` params: Record<string, any>

`Static` listCommunityInfluencerSubscriptions

`Optional` params: Record<string, any>

`Static` listCreatorSubscriptions

`Optional` params: Record<string, any>

`Static` listMyLicenses

`Optional` params: Record<string, any>

`Static` purchaseGift

`Static` purchaseLicense

`Static` redeemGift

`Static` refundLicense

`Static` validateCoupon

data: {
code: string;
currency?: string;
price: number;
}

`Optional` currency?: string