6471862601

Committed 10 Oct 2023 04:02PM UTC coverage: 69.665% (-0.5%) from 70.141%

Build # 6471862601

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1570 from localheinz/feature/coveralls

Enhancement: Use `coverallsapp/github-action` to report code coverage

Run Details

2393 of 3435 relevant lines covered (69.67%)

3.5 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.0

/lib/Service/SubscriptionService.php

<?php

// File generated from our OpenAPI spec

namespace Stripe\Service;

class SubscriptionService extends \Stripe\Service\AbstractService
{
    /**
     * By default, returns a list of subscriptions that have not been canceled. In
     * order to list canceled subscriptions, specify <code>status=canceled</code>.
     *
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Collection<\Stripe\Subscription>
     */
    public function all($params = null, $opts = null)
    {
        return $this->requestCollection('get', '/v1/subscriptions', $params, $opts);
    }

    /**
     * Cancels a customer’s subscription immediately. The customer will not be charged
     * again for the subscription.
     *
     * Note, however, that any pending invoice items that you’ve created will still be
     * charged for at the end of the period, unless manually <a
     * href="#delete_invoiceitem">deleted</a>. If you’ve set the subscription to cancel
     * at the end of the period, any pending prorations will also be left in place and
     * collected at the end of the period. But if the subscription is set to cancel
     * immediately, pending prorations will be removed.
     *
     * By default, upon subscription cancellation, Stripe will stop automatic
     * collection of all finalized invoices for the customer. This is intended to
     * prevent unexpected payment attempts after the customer has canceled a
     * subscription. However, you can resume automatic collection of the invoices
     * manually after subscription cancellation to have us proceed. Or, you could check
     * for unpaid invoices before allowing the customer to cancel the subscription at
     * all.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Subscription
     */
    public function cancel($id, $params = null, $opts = null)
    {
        return $this->request('delete', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);
    }

    /**
     * Creates a new subscription on an existing customer. Each customer can have up to
     * 500 active or scheduled subscriptions.
     *
     * When you create a subscription with
     * <code>collection_method=charge_automatically</code>, the first invoice is
     * finalized as part of the request. The <code>payment_behavior</code> parameter
     * determines the exact behavior of the initial payment.
     *
     * To start subscriptions where the first invoice always begins in a
     * <code>draft</code> status, use <a
     * href="/docs/billing/subscriptions/subscription-schedules#managing">subscription
     * schedules</a> instead. Schedules provide the flexibility to model more complex
     * billing configurations that change over time.
     *
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Subscription
     */
    public function create($params = null, $opts = null)
    {
        return $this->request('post', '/v1/subscriptions', $params, $opts);
    }

    /**
     * Removes the currently applied discount on a subscription.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Discount
     */
    public function deleteDiscount($id, $params = null, $opts = null)
    {
        return $this->request('delete', $this->buildPath('/v1/subscriptions/%s/discount', $id), $params, $opts);
    }

    /**
     * Initiates resumption of a paused subscription, optionally resetting the billing
     * cycle anchor and creating prorations. If a resumption invoice is generated, it
     * must be paid or marked uncollectible before the subscription will be unpaused.
     * If payment succeeds the subscription will become <code>active</code>, and if
     * payment fails the subscription will be <code>past_due</code>. The resumption
     * invoice will void automatically if not paid by the expiration date.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Subscription
     */
    public function resume($id, $params = null, $opts = null)
    {
        return $this->request('post', $this->buildPath('/v1/subscriptions/%s/resume', $id), $params, $opts);
    }

    /**
     * Retrieves the subscription with the given ID.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Subscription
     */
    public function retrieve($id, $params = null, $opts = null)
    {
        return $this->request('get', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);
    }

    /**
     * Search for subscriptions you’ve previously created using Stripe’s <a
     * href="/docs/search#search-query-language">Search Query Language</a>. Don’t use
     * search in read-after-write flows where strict consistency is necessary. Under
     * normal operating conditions, data is searchable in less than a minute.
     * Occasionally, propagation of new or updated data can be up to an hour behind
     * during outages. Search functionality is not available to merchants in India.
     *
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SearchResult<\Stripe\Subscription>
     */
    public function search($params = null, $opts = null)
    {
        return $this->requestSearchResult('get', '/v1/subscriptions/search', $params, $opts);
    }

    /**
     * Updates an existing subscription on a customer to match the specified
     * parameters. When changing plans or quantities, we will optionally prorate the
     * price we charge next month to make up for any price changes. To preview how the
     * proration will be calculated, use the <a href="#upcoming_invoice">upcoming
     * invoice</a> endpoint.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Subscription
     */
    public function update($id, $params = null, $opts = null)
    {
        return $this->request('post', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);
    }
}

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class SubscriptionService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* By default, returns a list of subscriptions that have not been canceled. In
11	* order to list canceled subscriptions, specify <code>status=canceled</code>.
12	*
13	* @param null\|array $params
14	* @param null\|array\|\Stripe\Util\RequestOptions $opts
15	*
16	* @throws \Stripe\Exception\ApiErrorException if the request fails
17	*
18	* @return \Stripe\Collection<\Stripe\Subscription>
19	*/
20	public function all($params = null, $opts = null)	2✔
21	{
22	return $this->requestCollection('get', '/v1/subscriptions', $params, $opts);	2✔
23	}
24
25	/**
26	* Cancels a customer’s subscription immediately. The customer will not be charged
27	* again for the subscription.
28	*
29	* Note, however, that any pending invoice items that you’ve created will still be
30	* charged for at the end of the period, unless manually <a
31	* href="#delete_invoiceitem">deleted</a>. If you’ve set the subscription to cancel
32	* at the end of the period, any pending prorations will also be left in place and
33	* collected at the end of the period. But if the subscription is set to cancel
34	* immediately, pending prorations will be removed.
35	*
36	* By default, upon subscription cancellation, Stripe will stop automatic
37	* collection of all finalized invoices for the customer. This is intended to
38	* prevent unexpected payment attempts after the customer has canceled a
39	* subscription. However, you can resume automatic collection of the invoices
40	* manually after subscription cancellation to have us proceed. Or, you could check
41	* for unpaid invoices before allowing the customer to cancel the subscription at
42	* all.
43	*
44	* @param string $id
45	* @param null\|array $params
46	* @param null\|array\|\Stripe\Util\RequestOptions $opts
47	*
48	* @throws \Stripe\Exception\ApiErrorException if the request fails
49	*
50	* @return \Stripe\Subscription
51	*/
52	public function cancel($id, $params = null, $opts = null)	1✔
53	{
54	return $this->request('delete', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);	1✔
55	}
56
57	/**
58	* Creates a new subscription on an existing customer. Each customer can have up to
59	* 500 active or scheduled subscriptions.
60	*
61	* When you create a subscription with
62	* <code>collection_method=charge_automatically</code>, the first invoice is
63	* finalized as part of the request. The <code>payment_behavior</code> parameter
64	* determines the exact behavior of the initial payment.
65	*
66	* To start subscriptions where the first invoice always begins in a
67	* <code>draft</code> status, use <a
68	* href="/docs/billing/subscriptions/subscription-schedules#managing">subscription
69	* schedules</a> instead. Schedules provide the flexibility to model more complex
70	* billing configurations that change over time.
71	*
72	* @param null\|array $params
73	* @param null\|array\|\Stripe\Util\RequestOptions $opts
74	*
75	* @throws \Stripe\Exception\ApiErrorException if the request fails
76	*
77	* @return \Stripe\Subscription
78	*/
79	public function create($params = null, $opts = null)	1✔
80	{
81	return $this->request('post', '/v1/subscriptions', $params, $opts);	1✔
82	}
83
84	/**
85	* Removes the currently applied discount on a subscription.
86	*
87	* @param string $id
88	* @param null\|array $params
89	* @param null\|array\|\Stripe\Util\RequestOptions $opts
90	*
91	* @throws \Stripe\Exception\ApiErrorException if the request fails
92	*
93	* @return \Stripe\Discount
94	*/
95	public function deleteDiscount($id, $params = null, $opts = null)	1✔
96	{
97	return $this->request('delete', $this->buildPath('/v1/subscriptions/%s/discount', $id), $params, $opts);	1✔
98	}
99
100	/**
101	* Initiates resumption of a paused subscription, optionally resetting the billing
102	* cycle anchor and creating prorations. If a resumption invoice is generated, it
103	* must be paid or marked uncollectible before the subscription will be unpaused.
104	* If payment succeeds the subscription will become <code>active</code>, and if
105	* payment fails the subscription will be <code>past_due</code>. The resumption
106	* invoice will void automatically if not paid by the expiration date.
107	*
108	* @param string $id
109	* @param null\|array $params
110	* @param null\|array\|\Stripe\Util\RequestOptions $opts
111	*
112	* @throws \Stripe\Exception\ApiErrorException if the request fails
113	*
114	* @return \Stripe\Subscription
115	*/
116	public function resume($id, $params = null, $opts = null)	×
117	{
118	return $this->request('post', $this->buildPath('/v1/subscriptions/%s/resume', $id), $params, $opts);	×
119	}
120
121	/**
122	* Retrieves the subscription with the given ID.
123	*
124	* @param string $id
125	* @param null\|array $params
126	* @param null\|array\|\Stripe\Util\RequestOptions $opts
127	*
128	* @throws \Stripe\Exception\ApiErrorException if the request fails
129	*
130	* @return \Stripe\Subscription
131	*/
132	public function retrieve($id, $params = null, $opts = null)	1✔
133	{
134	return $this->request('get', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);	1✔
135	}
136
137	/**
138	* Search for subscriptions you’ve previously created using Stripe’s <a
139	* href="/docs/search#search-query-language">Search Query Language</a>. Don’t use
140	* search in read-after-write flows where strict consistency is necessary. Under
141	* normal operating conditions, data is searchable in less than a minute.
142	* Occasionally, propagation of new or updated data can be up to an hour behind
143	* during outages. Search functionality is not available to merchants in India.
144	*
145	* @param null\|array $params
146	* @param null\|array\|\Stripe\Util\RequestOptions $opts
147	*
148	* @throws \Stripe\Exception\ApiErrorException if the request fails
149	*
150	* @return \Stripe\SearchResult<\Stripe\Subscription>
151	*/
152	public function search($params = null, $opts = null)	×
153	{
154	return $this->requestSearchResult('get', '/v1/subscriptions/search', $params, $opts);	×
155	}
156
157	/**
158	* Updates an existing subscription on a customer to match the specified
159	* parameters. When changing plans or quantities, we will optionally prorate the
160	* price we charge next month to make up for any price changes. To preview how the
161	* proration will be calculated, use the <a href="#upcoming_invoice">upcoming
162	* invoice</a> endpoint.
163	*
164	* @param string $id
165	* @param null\|array $params
166	* @param null\|array\|\Stripe\Util\RequestOptions $opts
167	*
168	* @throws \Stripe\Exception\ApiErrorException if the request fails
169	*
170	* @return \Stripe\Subscription
171	*/
172	public function update($id, $params = null, $opts = null)	1✔
173	{
174	return $this->request('post', $this->buildPath('/v1/subscriptions/%s', $id), $params, $opts);	1✔
175	}
176	}

stripe / stripe-php / 6471862601

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous