Package jp.gopay.sdk.resources

Interface SubscriptionsResource

public interface SubscriptionsResource

Resource for managing subscriptions.

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<FullSubscription>	createSubscription(SubscriptionCreateData dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<Void>	deleteSubscription(StoreId storeId, SubscriptionId subscriptionId)
retrofit2.Call<ScheduledPayment>	getPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)
retrofit2.Call<FullSubscription>	getSubscription(StoreId storeId, SubscriptionId subscriptionId, Boolean polling)
retrofit2.Call<PaginatedList<Subscription>>	listAllSubscriptions(Integer limit, CursorDirection cursorDirection, SubscriptionId cursor)
retrofit2.Call<PaginatedList<Subscription>>	listAllSubscriptions(StoreId storeId, Integer limit, CursorDirection cursorDirection, SubscriptionId cursor)
retrofit2.Call<PaginatedList<Charge>>	listChargesForPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId, Integer limit, CursorDirection cursorDirection, ChargeId cursor)
retrofit2.Call<PaginatedList<ScheduledPayment>>	listPayments(StoreId storeId, SubscriptionId subscriptionId, Integer limit, CursorDirection cursorDirection, ScheduledPaymentId cursor)
retrofit2.Call<PaginatedList<Charge>>	listSubscriptionCharges(StoreId storeId, SubscriptionId subscriptionId, Integer limit, CursorDirection cursorDirection, ChargeId cursor)
retrofit2.Call<PaymentsPlan>	simulateSubscriptionPlan(StoreId storeId, SubscriptionPlanSimulationRequest simulationRequest, IdempotencyKey idempotencyKey)
retrofit2.Call<PaymentsPlan>	simulateSubscriptionPlan(SubscriptionPlanSimulationRequest simulationRequest, IdempotencyKey idempotencyKey)
retrofit2.Call<ScheduledPayment>	updatePayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId, ScheduledPaymentPatchData patchData, IdempotencyKey idempotencyKey)
retrofit2.Call<FullSubscription>	updateSubscription(StoreId storeId, SubscriptionId subscriptionId, SubscriptionUpdateData dataToPost, IdempotencyKey idempotencyKey)

Method Detail

listAllSubscriptions

@GET("/subscriptions")
retrofit2.Call<PaginatedList<Subscription>> listAllSubscriptions(@Query("limit") @Nullable
                                                                 Integer limit,
                                                                 @Query("cursor_direction") @Nullable
                                                                 CursorDirection cursorDirection,
                                                                 @Query("cursor") @Nullable
                                                                 SubscriptionId cursor)

listAllSubscriptions

@GET("/stores/{storeId}/subscriptions")
retrofit2.Call<PaginatedList<Subscription>> listAllSubscriptions(@Path("storeId")
                                                                 StoreId storeId,
                                                                 @Query("limit") @Nullable
                                                                 Integer limit,
                                                                 @Query("cursor_direction") @Nullable
                                                                 CursorDirection cursorDirection,
                                                                 @Query("cursor") @Nullable
                                                                 SubscriptionId cursor)

getSubscription

@GET("/stores/{storeId}/subscriptions/{subscriptionId}")
retrofit2.Call<FullSubscription> getSubscription(@Path("storeId")
                                                 StoreId storeId,
                                                 @Path("subscriptionId")
                                                 SubscriptionId subscriptionId,
                                                 @Query("polling") @Nullable
                                                 Boolean polling)

createSubscription

@POST("/subscriptions")
retrofit2.Call<FullSubscription> createSubscription(@Body
                                                    SubscriptionCreateData dataToPost,
                                                    @Header("Idempotency-Key")
                                                    IdempotencyKey idempotencyKey)

updateSubscription

@PATCH("/stores/{storeId}/subscriptions/{subscriptionId}")
retrofit2.Call<FullSubscription> updateSubscription(@Path("storeId")
                                                    StoreId storeId,
                                                    @Path("subscriptionId")
                                                    SubscriptionId subscriptionId,
                                                    @Body
                                                    SubscriptionUpdateData dataToPost,
                                                    @Header("Idempotency-Key")
                                                    IdempotencyKey idempotencyKey)

listPayments

@GET("/stores/{storeId}/subscriptions/{subscriptionId}/payments")
retrofit2.Call<PaginatedList<ScheduledPayment>> listPayments(@Path("storeId")
                                                             StoreId storeId,
                                                             @Path("subscriptionId")
                                                             SubscriptionId subscriptionId,
                                                             @Query("limit") @Nullable
                                                             Integer limit,
                                                             @Query("cursor_direction") @Nullable
                                                             CursorDirection cursorDirection,
                                                             @Query("cursor") @Nullable
                                                             ScheduledPaymentId cursor)

getPayment

@GET("/stores/{storeId}/subscriptions/{subscriptionId}/payments/{paymentId}")
retrofit2.Call<ScheduledPayment> getPayment(@Path("storeId")
                                            StoreId storeId,
                                            @Path("subscriptionId")
                                            SubscriptionId subscriptionId,
                                            @Path("paymentId")
                                            ScheduledPaymentId paymentId)

listChargesForPayment

@GET("/stores/{storeId}/subscriptions/{subscriptionId}/payments/{paymentId}/charges")
retrofit2.Call<PaginatedList<Charge>> listChargesForPayment(@Path("storeId")
                                                            StoreId storeId,
                                                            @Path("subscriptionId")
                                                            SubscriptionId subscriptionId,
                                                            @Path("paymentId")
                                                            ScheduledPaymentId paymentId,
                                                            @Query("limit") @Nullable
                                                            Integer limit,
                                                            @Query("cursor_direction") @Nullable
                                                            CursorDirection cursorDirection,
                                                            @Query("cursor") @Nullable
                                                            ChargeId cursor)

updatePayment

@PATCH("/stores/{storeId}/subscriptions/{subscriptionId}/payments/{paymentId}")
retrofit2.Call<ScheduledPayment> updatePayment(@Path("storeId")
                                               StoreId storeId,
                                               @Path("subscriptionId")
                                               SubscriptionId subscriptionId,
                                               @Path("paymentId")
                                               ScheduledPaymentId paymentId,
                                               @Body
                                               ScheduledPaymentPatchData patchData,
                                               @Header("Idempotency-Key")
                                               IdempotencyKey idempotencyKey)

deleteSubscription

@DELETE("/stores/{storeId}/subscriptions/{subscriptionId}")
retrofit2.Call<Void> deleteSubscription(@Path("storeId")
                                        StoreId storeId,
                                        @Path("subscriptionId")
                                        SubscriptionId subscriptionId)

listSubscriptionCharges

@GET("/stores/{storeId}/subscriptions/{subscriptionId}/charges")
retrofit2.Call<PaginatedList<Charge>> listSubscriptionCharges(@Path("storeId")
                                                              StoreId storeId,
                                                              @Path("subscriptionId")
                                                              SubscriptionId subscriptionId,
                                                              @Query("limit") @Nullable
                                                              Integer limit,
                                                              @Query("cursor_direction") @Nullable
                                                              CursorDirection cursorDirection,
                                                              @Query("cursor") @Nullable
                                                              ChargeId cursor)

simulateSubscriptionPlan

@POST("/subscriptions/simulate_plan")
retrofit2.Call<PaymentsPlan> simulateSubscriptionPlan(@Body
                                                      SubscriptionPlanSimulationRequest simulationRequest,
                                                      @Header("Idempotency-Key")
                                                      IdempotencyKey idempotencyKey)

simulateSubscriptionPlan

@POST("/stores/{storeId}/subscriptions/simulate_plan")
retrofit2.Call<PaymentsPlan> simulateSubscriptionPlan(@Path("storeId")
                                                      StoreId storeId,
                                                      @Body
                                                      SubscriptionPlanSimulationRequest simulationRequest,
                                                      @Header("Idempotency-Key")
                                                      IdempotencyKey idempotencyKey)