ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / costbloc.com / vendor / stripe / stripe-php / lib / Service

<?php

// File generated from our OpenAPI spec

namespace Stripe\Service;

class SubscriptionScheduleService extends \Stripe\Service\AbstractService
{
    /**
     * Retrieves the list of your subscription schedules.
     *
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Collection<\Stripe\SubscriptionSchedule>
     */
    public function all($params = null, $opts = null)
    {
        return $this->requestCollection('get', '/v1/subscription_schedules', $params, $opts);
    }

/**
     * Cancels a subscription schedule and its associated subscription immediately (if
     * the subscription schedule has an active subscription). A subscription schedule
     * can only be canceled if its status is <code>not_started</code> or
     * <code>active</code>.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule
     */
    public function cancel($id, $params = null, $opts = null)
    {
        return $this->request('post', $this->buildPath('/v1/subscription_schedules/%s/cancel', $id), $params, $opts);
    }

/**
     * Creates a new subscription schedule object. Each customer can have up to 500
     * active or scheduled subscriptions.
     *
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule
     */
    public function create($params = null, $opts = null)
    {
        return $this->request('post', '/v1/subscription_schedules', $params, $opts);
    }

/**
     * Releases the subscription schedule immediately, which will stop scheduling of
     * its phases, but leave any existing subscription in place. A schedule can only be
     * released if its status is <code>not_started</code> or <code>active</code>. If
     * the subscription schedule is currently associated with a subscription, releasing
     * it will remove its <code>subscription</code> property and set the subscription’s
     * ID to the <code>released_subscription</code> property.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule
     */
    public function release($id, $params = null, $opts = null)
    {
        return $this->request('post', $this->buildPath('/v1/subscription_schedules/%s/release', $id), $params, $opts);
    }

/**
     * Retrieves the details of an existing subscription schedule. You only need to
     * supply the unique subscription schedule identifier that was returned upon
     * subscription schedule creation.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule
     */
    public function retrieve($id, $params = null, $opts = null)
    {
        return $this->request('get', $this->buildPath('/v1/subscription_schedules/%s', $id), $params, $opts);
    }

/**
     * Updates an existing subscription schedule.
     *
     * @param string $id
     * @param null|array $params
     * @param null|array|\Stripe\Util\RequestOptions $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule
     */
    public function update($id, $params = null, $opts = null)
    {
        return $this->request('post', $this->buildPath('/v1/subscription_schedules/%s', $id), $params, $opts);
    }
}

[-] PaymentIntentService.php [edit]
[-] SubscriptionService.php [edit]
[+] Terminal
[-] AbstractService.php [edit]
[-] PaymentMethodService.php [edit]
[-] ReviewService.php [edit]
[-] AccountLinkService.php [edit]
[-] DisputeService.php [edit]
[-] ExchangeRateService.php [edit]
[-] EventService.php [edit]
[-] WebhookEndpointService.php [edit]
[+] Sigma
[-] PriceService.php [edit]
[+] ..
[-] EphemeralKeyService.php [edit]
[-] PayoutService.php [edit]
[-] SubscriptionScheduleService.php [edit]
[-] SubscriptionItemService.php [edit]
[-] ChargeService.php [edit]
[-] CreditNoteService.php [edit]
[-] PlanService.php [edit]
[-] ShippingRateService.php [edit]
[-] BalanceService.php [edit]
[-] RefundService.php [edit]
[-] OAuthService.php [edit]
[-] SourceService.php [edit]
[+] FinancialConnections
[+] Issuing
[-] TaxCodeService.php [edit]
[-] PaymentLinkService.php [edit]
[-] TokenService.php [edit]
[-] ApplicationFeeService.php [edit]
[-] OrderReturnService.php [edit]
[-] PromotionCodeService.php [edit]
[-] FileService.php [edit]
[-] BalanceTransactionService.php [edit]
[-] QuoteService.php [edit]
[-] SkuService.php [edit]
[+] Checkout
[-] CountrySpecService.php [edit]
[-] SetupAttemptService.php [edit]
[-] MandateService.php [edit]
[+] Radar
[-] ProductService.php [edit]
[-] InvoiceService.php [edit]
[-] FileLinkService.php [edit]
[-] TransferService.php [edit]
[-] SetupIntentService.php [edit]
[-] AbstractServiceFactory.php [edit]
[+] BillingPortal
[-] TaxRateService.php [edit]
[-] TopupService.php [edit]
[-] CoreServiceFactory.php [edit]
[-] CustomerService.php [edit]
[+] Reporting
[-] CouponService.php [edit]
[-] AccountService.php [edit]
[+] TestHelpers
[-] InvoiceItemService.php [edit]
[-] OrderService.php [edit]
[+] Identity
[-] ApplePayDomainService.php [edit]