* * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function all($params = null, $opts = null) { return $this->requestCollection('get', '/v1/plans', $params, $opts); } /** * You can now model subscriptions more flexibly using the Prices * API. It replaces the Plans API and is backwards compatible to simplify your * migration. * * @param null|array{active?: bool, amount?: int, amount_decimal?: string, billing_scheme?: string, currency: string, expand?: string[], id?: string, interval: string, interval_count?: int, metadata?: null|array, meter?: string, nickname?: string, product?: array|string, tiers?: (array{flat_amount?: int, flat_amount_decimal?: string, unit_amount?: int, unit_amount_decimal?: string, up_to: array|int|string})[], tiers_mode?: string, transform_usage?: array{divide_by: int, round: string}, trial_period_days?: int, usage_type?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Plan * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function create($params = null, $opts = null) { return $this->request('post', '/v1/plans', $params, $opts); } /** * Deleting plans means new subscribers can’t be added. Existing subscribers aren’t * affected. * * @param string $id * @param null|array $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Plan * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function delete($id, $params = null, $opts = null) { return $this->request('delete', $this->buildPath('/v1/plans/%s', $id), $params, $opts); } /** * Retrieves the plan with the given ID. * * @param string $id * @param null|array{expand?: string[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Plan * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function retrieve($id, $params = null, $opts = null) { return $this->request('get', $this->buildPath('/v1/plans/%s', $id), $params, $opts); } /** * Updates the specified plan by setting the values of the parameters passed. Any * parameters not provided are left unchanged. By design, you cannot change a * plan’s ID, amount, currency, or billing cycle. * * @param string $id * @param null|array{active?: bool, expand?: string[], metadata?: null|array, nickname?: string, product?: string, trial_period_days?: int} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Plan * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function update($id, $params = null, $opts = null) { return $this->request('post', $this->buildPath('/v1/plans/%s', $id), $params, $opts); } }