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

Plan

class Plan extends Resource implements PlanInterface

Plans define the base price, currency, and billing cycle for subscriptions.

For example, you might have a $5/month plan that provides limited access to your products, and a $15/month plan that allows full access.

Traits

Retrieve
Retrieve.
Update
Update.
ListAll
List All.
Delete
Delete.

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

Delete a resource.

from Delete
PlanInterface
create(array $arguments, string $key = null)

You can create plans using the API, or in the Stripe Dashboard.

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

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

at line 31
PlanInterface create(array $arguments, string $key = null)

You can create plans using the API, or in the Stripe Dashboard.

Parameters

array $arguments
string $key

Return Value

PlanInterface

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

Parameters

string $method
$arguments
string $idempotencyKey