1. class
  2. Bulldog
  3. \
  4. Strype
  5. \
  6. Resources
  7. \
  8. Subscription

Subscription

class Subscription extends Resource implements SubscriptionInterface

Subscriptions allow you to charge a customer on a recurring basis. A subscription ties a customer to a particular plan you've created.

Traits

Retrieve
Retrieve.
Update
Update.
ListAll
List All.

Properties

string $id A unique identifier for the resource. from Resource
protected mixed $response A response from Stripe. from Resource

Methods

string
getId()

Returns the unique identifier for this resource.

from Resource
mixed
getResponse()

Returns the raw Stripe response.

from Resource
void
setProperties()

Set the response data as properties on the class.

from Resource
Retrieve
retrieve(string $id)

Get a resource by the ID.

from Retrieve
Update
update(string $id, array $data)

Update a resource.

from Update
ListAll
listAll(array $arguments = [])

List all the resources.

from ListAll
SubscriptionInterface
create(CustomerInterface $customer, SubscriptionBillingTypeInterface $billing, array $items = [], array $arguments = [], string $key = null)

Creates a new subscription on an existing customer.

SubscriptionInterface
cancel(string $id)

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

void
stripe(string $method, $arguments, string $idempotencyKey = null)

No description

Details

in Resource at line 29
string getId()

Returns the unique identifier for this resource.

Return Value

string

in Resource at line 39
mixed getResponse()

Returns the raw Stripe response.

Return Value

mixed

in Resource at line 47
protected void setProperties()

Set the response data as properties on the class.

Return Value

void

in Retrieve at line 17
Retrieve retrieve(string $id)

Get a resource by the ID.

Parameters

string $id

Return Value

Retrieve

in Update at line 18
Update update(string $id, array $data)

Update a resource.

Parameters

string $id
array $data

Return Value

Update

in ListAll at line 21
ListAll listAll(array $arguments = [])

List all the resources.

This will list all of the resources from which this trait belongs to. It will then return itself, so you can method chain it, or reuse the same instantiation.

Parameters

array $arguments

Return Value

ListAll

at line 36
SubscriptionInterface create(CustomerInterface $customer, SubscriptionBillingTypeInterface $billing, array $items = [], array $arguments = [], string $key = null)

Creates a new subscription on an existing customer.

Parameters

CustomerInterface $customer
SubscriptionBillingTypeInterface $billing
array $items
array $arguments
string $key

Return Value

SubscriptionInterface

See also

at line 56
SubscriptionInterface cancel(string $id)

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

Parameters

string $id

Return Value

SubscriptionInterface

See also

at line 65
protected void stripe(string $method, $arguments, string $idempotencyKey = null)

Parameters

string $method
$arguments
string $idempotencyKey

Return Value

void