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

SubscriptionItem

class SubscriptionItem extends Resource implements SubscriptionItemInterface

Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

Traits

Retrieve
Retrieve.
Update
Update.
Delete
Delete.
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
Delete
delete(string $id)

Delete a resource.

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

List all the resources.

from ListAll
SubscriptionItemInterface
create(PlanInterface $plan, SubscriptionInterface $subscription, array $arguments = [], string $key = null)

Adds a new item to an existing subscription. No existing items will be changed or replaced.

stripe(string $method, $arguments, $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 Delete at line 21
Delete delete(string $id)

Delete a resource.

Delete a resource associated with the class this trait is being used. You must pass in the ID of the resource that you wish to delete. Then it will return the same instance of the class from which it was called.

Parameters

string $id

Return Value

Delete

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 34
SubscriptionItemInterface create(PlanInterface $plan, SubscriptionInterface $subscription, array $arguments = [], string $key = null)

Adds a new item to an existing subscription. No existing items will be changed or replaced.

Parameters

PlanInterface $plan
SubscriptionInterface $subscription
array $arguments
string $key

Return Value

SubscriptionItemInterface

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

Parameters

string $method
$arguments
$idempotencyKey