DiscordPHP Documentation

Subscription extends Part
in package

Application

Subscriptions in Discord represent a user making recurring payments for at least one SKU over an ongoing period.

Subscription status should not be used to grant perks. Use entitlements as an indication of whether a user should have access to a specific SKU. See the guide on Implementing App Subscriptions for more information.

Constants

STATUS_ACTIVE = 0
STATUS_ENDING = 1
STATUS_INACTIVE = 2

Properties

$canceled_at : Carbon|null
$country : string|null
$created : bool: Is the part already created in the Discord servers?
$current_period_end : Carbon
$current_period_start : Carbon
$entitlement_ids : array<string|int, mixed>
$id : string
$renewal_sku_ids : array<string|int, mixed>|null
$scriptData : mixed: Custom script data.
$sku_ids : array<string|int, mixed>
$status : int
$user_id : string
$attributes : array<string|int, mixed>: The parts attributes.
$discord : Discord: The Discord client.
$factory : Factory: The factory.
$fillable : array<string|int, mixed>: The parts fillable attributes.
$hidden : array<string|int, mixed>: Attributes that are hidden from debug info.
$http : Http: The HTTP client.
$repositories : array<string|int, mixed>: An array of repositories that can exist in a part.
$repositories_cache : array<string|int, mixed>: An array of repositories.
$visible : array<string|int, mixed>: Attributes which are visible from debug info.

Methods

__construct() : mixed: Create a new part instance.
__debugInfo() : array<string|int, mixed>
__get() : mixed: Handles dynamic get calls onto the part.
__serialize() : array<string|int, mixed>
__set() : void: Handles dynamic set calls onto the part.
__toString() : string: Converts the part to a string.
__unserialize() : void
fetch() : PromiseInterface<string|int, static>: Fetches any missing information about the part from Discord's servers.
fill() : void: Fills the parts attributes from an array.
getCreatableAttributes() : array<string|int, mixed>: Returns the attributes needed to create.
getDiscord() : Discord: Get the Discord instance that owns this Part.
getPublicAttributes() : array<string|int, mixed>: Returns an array of public attributes.
getRawAttributes() : array<string|int, mixed>: Returns an array of raw attributes.
getRepositoryAttributes() : array<string|int, mixed>: Gets the attributes to pass to repositories.
getUpdatableAttributes() : array<string|int, mixed>: Returns the updatable attributes.
isPartial() : bool: Whether the part is considered partial i.e. missing information which can be fetched from Discord.
jsonSerialize() : array<string|int, mixed>: Provides data when the part is encoded into JSON. Used for JsonSerializable.
offsetExists() : bool: Checks if an attribute exists via key. Used for ArrayAccess.
offsetGet() : mixed: Gets an attribute via key. Used for ArrayAccess.
offsetSet() : void: Sets an attribute via key. Used for ArrayAccess.
offsetUnset() : void: Unsets an attribute via key. Used for ArrayAccess.
serialize() : string|null: Serializes the data. Used for Serializable.
unserialize() : void: Unserializes some data and stores it. Used for Serializable.
afterConstruct() : void: Called after the part has been constructed.
getCanceledAtAttribute() : Carbon|null: Get the canceled_at timestamp as a Carbon instance.
getCurrentPeriodEndAttribute() : Carbon|null: Get the end of the current subscription period as a Carbon instance.
getCurrentPeriodStartAttribute() : Carbon|null: Get the start of the current subscription period as a Carbon instance.
makeOptionalAttributes() : array<string|int, mixed>: Return key-value attributes if it has been filled.
checkForGetMutator() : string|false: Checks if there is a get mutator present.
checkForSetMutator() : string|false: Checks if there is a set mutator present.
getAttribute() : mixed: Gets an attribute on the part.
setAttribute() : void: Sets an attribute on the part.
studly() : string: Converts a string to studlyCase.

STATUS_ACTIVE


    public
        mixed
    STATUS_ACTIVE
    = 0

STATUS_ENDING


    public
        mixed
    STATUS_ENDING
    = 1

STATUS_INACTIVE


    public
        mixed
    STATUS_INACTIVE
    = 2

$canceled_at


    public
        Carbon|null
    $canceled_at

When the subscription was canceled.

$country


    public
        string|null
    $country

ISO3166-1 alpha-2 country code of the payment source used to purchase the subscription. Missing unless queried with a private OAuth scope.

$created

Is the part already created in the Discord servers?


    public
        bool
    $created
     = false

Whether the part has been created.

$current_period_end


    public
        Carbon
    $current_period_end

End of the current subscription period.

$current_period_start


    public
        Carbon
    $current_period_start

Start of the current subscription period.

$entitlement_ids


    public
        array<string|int, mixed>
    $entitlement_ids

List of entitlements granted for this subscription.

$id


    public
        string
    $id

ID of the subscription.

$renewal_sku_ids


    public
        array<string|int, mixed>|null
    $renewal_sku_ids

List of SKUs that this user will be subscribed to at renewal.

$scriptData

Custom script data.

Relying on this variable with dynamic caching is discouraged.


    public
        mixed
    $scriptData

Used for storing custom information, used by end products.

$sku_ids


    public
        array<string|int, mixed>
    $sku_ids

List of SKUs subscribed to.

$status


    public
        int
    $status

Current status of the subscription.

$user_id


    public
        string
    $user_id

ID of the user who is subscribed.

$attributes

The parts attributes.


    protected
        array<string|int, mixed>
    $attributes
     = []

The parts attributes and content.

$discord

The Discord client.


    protected
        Discord
    $discord

Client.

$factory

The factory.


    protected
        Factory
    $factory

Factory.

$fillable

The parts fillable attributes.


    protected
        array<string|int, mixed>
    $fillable
     = ['id', 'user_id', 'sku_ids', 'entitlement_ids', 'renewal_sku_ids', 'current_period_start', 'current_period_end', 'status', 'canceled_at', 'country']

The array of attributes that can be mass-assigned.

$hidden

Attributes that are hidden from debug info.


    protected
        array<string|int, mixed>
    $hidden
     = []

Attributes that are hidden from public.

$http

The HTTP client.


    protected
        Http
    $http

Client.

$repositories

An array of repositories that can exist in a part.


    protected
        array<string|int, mixed>
    $repositories
     = []

Repositories.

$repositories_cache

An array of repositories.


    protected
        array<string|int, mixed>
    $repositories_cache
     = []

$visible

Attributes which are visible from debug info.


    protected
        array<string|int, mixed>
    $visible
     = []

__construct()

Create a new part instance.


    public
                    __construct(Discord $discord[, array<string|int, mixed> $attributes = [] ][, bool $created = false ]) : mixed

Parameters

$discord : Discord: The Discord client.
$attributes : array<string|int, mixed> = []: An array of attributes to build the part.
$created : bool = false: Whether the part has already been created.

__debugInfo()


    public
                    __debugInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

__get()

Handles dynamic get calls onto the part.


    public
                    __get(string $key) : mixed

Parameters

$key : string: The attributes key.

Return values

mixed —

The value of the attribute.

__serialize()


    public
                    __serialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

__set()

Handles dynamic set calls onto the part.


    public
                    __set(string $key, mixed $value) : void

Parameters

$key : string: The attributes key.
$value : mixed: The attributes value.

__toString()

Converts the part to a string.


    public
                    __toString() : string

Return values

string —

A JSON string of attributes.

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

fetch()

Fetches any missing information about the part from Discord's servers.


    public
                    fetch() : PromiseInterface<string|int, static>

Return values

PromiseInterface<string|int, static>

fill()

Fills the parts attributes from an array.


    public
                    fill(array<string|int, mixed> $attributes) : void

Parameters

$attributes : array<string|int, mixed>: An array of attributes to build the part.

getCreatableAttributes()

Returns the attributes needed to create.


    public
                    getCreatableAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed>

getDiscord()

Get the Discord instance that owns this Part.


    public
                    getDiscord() : Discord

Return values

Discord

getPublicAttributes()

Returns an array of public attributes.


    public
                    getPublicAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An array of public attributes.

getRawAttributes()

Returns an array of raw attributes.


    public
                    getRawAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Raw attributes.

getRepositoryAttributes()

Gets the attributes to pass to repositories.


    public
                    getRepositoryAttributes() : array<string|int, mixed>

Note: The order matters for repository tree (top to bottom).

Return values

array<string|int, mixed> —

Attributes.

getUpdatableAttributes()

Returns the updatable attributes.


    public
                    getUpdatableAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed>

isPartial()

Whether the part is considered partial i.e. missing information which can be fetched from Discord.


    public
                    isPartial() : bool

Return values

bool

jsonSerialize()

Provides data when the part is encoded into JSON. Used for JsonSerializable.


    public
                    jsonSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An array of public attributes.

offsetExists()

Checks if an attribute exists via key. Used for ArrayAccess.


    public
                    offsetExists(string $key) : bool

Parameters

$key : string: The attribute key.

Return values

bool —

Whether the offset exists.

offsetGet()

Gets an attribute via key. Used for ArrayAccess.


    public
                    offsetGet(string $key) : mixed

Parameters

$key : string: The attribute key.

offsetSet()

Sets an attribute via key. Used for ArrayAccess.


    public
                    offsetSet(string $key, mixed $value) : void

Parameters

$key : string: The attribute key.
$value : mixed: The attribute value.

offsetUnset()

Unsets an attribute via key. Used for ArrayAccess.


    public
                    offsetUnset(string $key) : void

Parameters

$key : string: The attribute key.

serialize()

Serializes the data. Used for Serializable.


    public
                    serialize() : string|null

Return values

string|null —

A string of serialized data.

unserialize()

Unserializes some data and stores it. Used for Serializable.


    public
                    unserialize(string $data) : void

Parameters

$data : string: Some serialized data.

afterConstruct()

Called after the part has been constructed.


    protected
                    afterConstruct() : void

getCanceledAtAttribute()

Get the canceled_at timestamp as a Carbon instance.


    protected
                    getCanceledAtAttribute() : Carbon|null

Return values

Carbon|null

getCurrentPeriodEndAttribute()

Get the end of the current subscription period as a Carbon instance.


    protected
                    getCurrentPeriodEndAttribute() : Carbon|null

Return values

Carbon|null

getCurrentPeriodStartAttribute()

Get the start of the current subscription period as a Carbon instance.


    protected
                    getCurrentPeriodStartAttribute() : Carbon|null

Return values

Carbon|null

makeOptionalAttributes()

Return key-value attributes if it has been filled.


    protected
                    makeOptionalAttributes(array<string|int, mixed> $attributes) : array<string|int, mixed>

To be used with fields marked "optional?" from the API.

Parameters

$attributes : array<string|int, mixed>: Names of optional attribute

Return values

array<string|int, mixed>

checkForGetMutator()

Checks if there is a get mutator present.


    private
                    checkForGetMutator(string $key) : string|false

Parameters

$key : string: The attribute name to check.

Return values

string|false —

Either a string if it is a method or false.

checkForSetMutator()

Checks if there is a set mutator present.


    private
                    checkForSetMutator(string $key) : string|false

Parameters

$key : string: The attribute name to check.

Return values

string|false —

Either a string if it is a method or false.

getAttribute()

Gets an attribute on the part.


    private
                    getAttribute(string $key) : mixed

Parameters

$key : string: The key to the attribute.

Return values

mixed —

Either the attribute if it exists or void.

setAttribute()

Sets an attribute on the part.


    private
                    setAttribute(string $key, mixed $value) : void

Parameters

$key : string: The key to the attribute.
$value : mixed: The value of the attribute.

studly()

Converts a string to studlyCase.


    private
            static        studly(string $string) : string

This is a port of updated Laravel's implementation, a non-regex with static cache. The Discord\studly() is kept due to unintended bug and we do not want to introduce BC by replacing it. This method is private static as we may move it outside this class in future.

Parameters

$string : string: The string to convert.

Return values

string

Subscription extends Part in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

STATUS_ACTIVE

STATUS_ENDING

STATUS_INACTIVE

Properties

$canceled_at

$country

$created

$current_period_end

$current_period_start

$entitlement_ids

$id

$renewal_sku_ids

$scriptData

$sku_ids

$status

$user_id

$attributes

$discord

$factory

$fillable

$hidden

$http

$repositories

$repositories_cache

$visible

Methods

__construct()

Parameters

__debugInfo()

Return values

__get()

Parameters

Tags

Return values

__serialize()

Return values

__set()

Parameters

Tags

__toString()

Tags

Return values

__unserialize()

Parameters

fetch()

Tags

Return values

fill()

Parameters

Tags

getCreatableAttributes()

Return values

getDiscord()

Return values

getPublicAttributes()

Tags

Return values

getRawAttributes()

Return values

getRepositoryAttributes()

Return values

getUpdatableAttributes()

Return values

isPartial()

Return values

jsonSerialize()

Tags

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Subscription extends Part
in package

Application